Get Armada Client

GET 
/v1/environment/:environment_id/client/armada

Get instance server client credentials for an environment

Request

Path Parameters

environment_id uuidrequired

The environment ID

Responses

200

Successful Response

application/json

Schema

Schema

client_id uuidrequired

The ID of the client for these credentials

client_secret Client Secret (string)required

Client secret in raw format. Requires specific permission.

environment_id uuidrequired

Option Environment scope for this client to a single Environment.

Example (from schema)

{
  "client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "client_secret": "string",
  "environment_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

400

Bad Request

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...