Get the configuration status

This endpoint allows you to check the status of the most recent configuration process: Note that you may need to wait several seconds after you start a process before you can check its status. The different statuses are: | Status | Description | | ------------- | --------------------------------- | | `PENDING` | The job has not started yet | | `CONFIGURING` | The job is running | | `DONE` | The job has finished correctly | | `FAILED` | The job has finished unexpectedly |

GET/setup/api/configcheck

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Responses

application/json configuration-status object

Response

progress array[object]

optional

items object

key string

required

status string

required

status string

optional

Response Example: 200 application/json

{
  "progress": [
    {
      "key": "Appliance core components",
      "status": "DONE"
    },
    {
      "key": "GitHub utilities",
      "status": "DONE"
    },
    {
      "key": "GitHub applications",
      "status": "DONE"
    },
    {
      "key": "GitHub services",
      "status": "CONFIGURING"
    },
    {
      "key": "Reloading appliance services",
      "status": "PENDING"
    }
  ],
  "status": "running"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/setup/api/configcheck