openapi.json

{
    "openapi": "3.0.0",
    "info": {
        "title": "config-manager",
        "version": "2"
    },
    "servers": [
        {
            "url": "/api/config-manager/v2"
        }
    ],
    "paths": {
        "/profiles": {
            "get": {
                "operationId": "getProfiles",
                "summary": "Get a list of all profiles",
                "description": "Retrieve a paginated array of profiles for the identified account. The URL query parameters 'limit' and 'offset' can be used to paginate the results. The default value of 'limit' is 50. The default value of 'offset' is 0.",
                "parameters": [
                    {
                        "name": "sort_by",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "default": "created_at:desc",
                            "enum": [
                                "created_at",
                                "created_at:asc",
                                "created_at:desc"
                            ]
                        }
                    },
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "integer",
                            "default": 50
                        }
                    },
                    {
                        "name": "offset",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "total": {
                                            "type": "integer"
                                        },
                                        "count": {
                                            "type": "integer"
                                        },
                                        "limit": {
                                            "type": "integer"
                                        },
                                        "offset": {
                                            "type": "integer"
                                        },
                                        "results": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/components/schemas/Profile"
                                            }
                                        }
                                    },
                                    "required": [
                                        "total",
                                        "count",
                                        "limit",
                                        "offset",
                                        "results"
                                    ]
                                }
                            }
                        }
                    },
                    "400": {
                        "$ref": "#/components/responses/400"
                    },
                    "500": {
                        "$ref": "#/components/responses/500"
                    }
                }
            },
            "post": {
                "operationId": "createProfile",
                "summary": "Create a new profile",
                "description": "Create and optionally activate a new profile.",
                "parameters": [],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "active": {
                                        "type": "boolean",
                                        "description": "Remote host configuration enabled state"
                                    },
                                    "compliance": {
                                        "type": "boolean",
                                        "description": "Remote configuration status for running Compliance data collection"
                                    },
                                    "insights": {
                                        "type": "boolean",
                                        "description": "Remote configuration status for running Insights data collection"
                                    },
                                    "remediations": {
                                        "type": "boolean",
                                        "description": "Remote configuration status for running Remediation playbooks"
                                    }
                                },
                                "required": [
                                    "active",
                                    "compliance",
                                    "insights",
                                    "remediations"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "201": {
                        "description": "Created",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Profile"
                                }
                            }
                        }
                    },
                    "304": {
                        "description": "Not Modified",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Profile"
                                }
                            }
                        }
                    },
                    "400": {
                        "$ref": "#/components/responses/400"
                    },
                    "500": {
                        "$ref": "#/components/responses/500"
                    }
                }
            }
        },
        "/profiles/{id}": {
            "get": {
                "operationId": "getProfile",
                "summary": "Get a specific profile",
                "description": "Retrieve a specific profile identified by the 'id' path parameter for the identified account. If the special value \"current\" is used for the 'id' path parameter, the most recent profile is retrieved instead.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Profile"
                                }
                            }
                        }
                    },
                    "400": {
                        "$ref": "#/components/responses/400"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "500": {
                        "$ref": "#/components/responses/500"
                    }
                }
            }
        },
        "/playbooks": {
            "get": {
                "operationId": "getPlaybook",
                "summary": "Retrieve an Ansible playbook for the requested profile",
                "description": "Constructs and returns a Ansible playbook suitable to configure a host for the requested profile.",
                "parameters": [
                    {
                        "name": "profile_id",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/x-yaml": {
                                "schema": {
                                    "type": "object"
                                }
                            }
                        }
                    },
                    "400": {
                        "$ref": "#/components/responses/400"
                    },
                    "404": {
                        "$ref": "#/components/responses/404"
                    },
                    "500": {
                        "$ref": "#/components/responses/500"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "Profile": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "string",
                        "description": "Profile unique identity value"
                    },
                    "account_id": {
                        "type": "string",
                        "description": "Red Hat account number"
                    },
                    "org_id": {
                        "type": "string",
                        "description": "Red Hat organization identity value"
                    },
                    "created_at": {
                        "type": "string",
                        "description": "Time of profile creation"
                    },
                    "active": {
                        "type": "boolean",
                        "description": "Remote host configuration enabled state"
                    },
                    "compliance": {
                        "type": "boolean",
                        "description": "Remote configuration status for running Compliance data collection"
                    },
                    "insights": {
                        "type": "boolean",
                        "description": "Remote configuration status for running Insights data collection"
                    },
                    "remediations": {
                        "type": "boolean",
                        "description": "Remote configuration status for running Remediation playbooks"
                    }
                }
            }
        },
        "responses": {
            "400": {
                "description": "Bad Request",
                "content": {
                    "text/plain": {
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            },
            "404": {
                "description": "Not Found",
                "content": {
                    "text/plain": {
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            },
            "500": {
                "description": "Internal Server Error",
                "content": {
                    "text/plain": {
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        }
    }
}