Set runner roles

PUT /platform/infrastructure/runners/{runner_id}/roles

Auth

Set runner roles.

Path parameters

runner_id string required: The identifier for the runner

Query parameters

bless boolean: Assigns the runner to the roles.

Request body

The roles for the runner that you want to apply.

roles object[] required: List of roles

Responses

The roles for the {runner_id} specified runner are assigned.

application/json

roles object[] required: List of roles

There was an error while assigning the roles for the {runner_id} specified runner. Try your request again. (code: runners.runner_set_roles_failed)

application/json

Unable to find the {runner_id} specified runner. Edit your request, then try again. (code: runners.runner_not_found)

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X PUT "${API_URL}/platform/infrastructure/runners/${RUNNER_ID}/roles" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "roles": [
      {
        "role_name": "string"
      }
    ]
  }'

Generated from the API spec

Response

{
  "roles": [
    {
      "role_name": "string"
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

Set runner roles

Path parameters

Query parameters

Request body

Responses

Response headers

Response headers

Path parameters

Query parameters

Request body { }

Responses

Response headers

Response headers

Request body