Get started with the REST API

Get started with the automation orchestrator REST API by authenticating, making a request, and exploring available endpoints.

Before you begin

  • A running automation orchestrator instance is accessible from your environment.
  • You have valid credentials: local password login, an OpenID Connect (OIDC) identity provider, or a service account with client credentials.

Procedure

  1. Obtain an access token by sending a POST request to the login endpoint: 
    POST https://orchestrator-host/api/v1/auth/login
Content-Type: application/json

{
  "username": "your_username",
  "password": "your_password"
}

    The response includes an access_token. Include it in all subsequent requests as an Authorization header:

    Authorization: Bearer access_token

    For service accounts, use the OAuth 2.0 client credentials grant at /api/v1/auth/token instead.

  2. List available workflows to verify your connection: 
    GET https://orchestrator-host/api/v1/workflows
Authorization: Bearer access_token

    All endpoints use the /api/v1 path prefix and return JSON.

  3. Open the interactive API documentation in your browser to explore the full API surface:
    • Swagger UI: https://orchestrator-host/api_docs/v1/docs
    • ReDoc: https://orchestrator-host/api_docs/v1/redoc

    These endpoints are enabled by default and do not require authentication. An administrator can disable them by setting the APP_ENABLE_API_DOCS environment variable to false on the back-end deployment.