Agents API

{{< details >}}

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

{{< /history >}}

Use the Agents API to work with the GitLab agent for Kubernetes.

List the agents for a project

Returns the list of agents registered for the project.

You must have at least the Developer role to use this endpoint. 

GET /projects/:id/cluster_agents

Parameters:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user

Response:

The response is a list of agents with the following fields:

Attribute Type Description
id integer ID of the agent
name string Name of the agent
config_project object Object representing the project the agent belongs to
config_project.id integer ID of the project
config_project.description string Description of the project
config_project.name string Name of the project
config_project.name_with_namespace string Full name with namespace of the project
config_project.path string Path to the project
config_project.path_with_namespace string Full path with namespace to the project
config_project.created_at string ISO8601 datetime when the project was created
created_at string ISO8601 datetime when the agent was created
created_by_user_id integer ID of the user who created the agent

Example request: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents"

Example response: 

[
  {
    "id": 1,
    "name": "agent-1",
    "config_project": {
      "id": 20,
      "description": "",
      "name": "test",
      "name_with_namespace": "Administrator / test",
      "path": "test",
      "path_with_namespace": "root/test",
      "created_at": "2022-03-20T20:42:40.221Z"
    },
    "created_at": "2022-04-20T20:42:40.221Z",
    "created_by_user_id": 42
  },
  {
    "id": 2,
    "name": "agent-2",
    "config_project": {
      "id": 20,
      "description": "",
      "name": "test",
      "name_with_namespace": "Administrator / test",
      "path": "test",
      "path_with_namespace": "root/test",
      "created_at": "2022-03-20T20:42:40.221Z"
    },
    "created_at": "2022-04-20T20:42:40.221Z",
    "created_by_user_id": 42
  }
]

Get details about an agent

Gets a single agent details.

You must have at least the Developer role to use this endpoint. 

GET /projects/:id/cluster_agents/:agent_id

Parameters:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user
agent_id integer yes ID of the agent

Response:

The response is a single agent with the following fields:

Attribute Type Description
id integer ID of the agent
name string Name of the agent
config_project object Object representing the project the agent belongs to
config_project.id integer ID of the project
config_project.description string Description of the project
config_project.name string Name of the project
config_project.name_with_namespace string Full name with namespace of the project
config_project.path string Path to the project
config_project.path_with_namespace string Full path with namespace to the project
config_project.created_at string ISO8601 datetime when the project was created
created_at string ISO8601 datetime when the agent was created
created_by_user_id integer ID of the user who created the agent

Example request: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/1"

Example response: 

{
  "id": 1,
  "name": "agent-1",
  "config_project": {
    "id": 20,
    "description": "",
    "name": "test",
    "name_with_namespace": "Administrator / test",
    "path": "test",
    "path_with_namespace": "root/test",
    "created_at": "2022-03-20T20:42:40.221Z"
  },
  "created_at": "2022-04-20T20:42:40.221Z",
  "created_by_user_id": 42
}

Register an agent with a project

Registers an agent to the project.

You must have at least the Maintainer role to use this endpoint. 

POST /projects/:id/cluster_agents

Parameters:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user
name string yes Name for the agent

Response:

The response is the new agent with the following fields:

Attribute Type Description
id integer ID of the agent
name string Name of the agent
config_project object Object representing the project the agent belongs to
config_project.id integer ID of the project
config_project.description string Description of the project
config_project.name string Name of the project
config_project.name_with_namespace string Full name with namespace of the project
config_project.path string Path to the project
config_project.path_with_namespace string Full path with namespace to the project
config_project.created_at string ISO8601 datetime when the project was created
created_at string ISO8601 datetime when the agent was created
created_by_user_id integer ID of the user who created the agent

Example request: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents" \
    -H "Content-Type:application/json" \
    -X POST --data '{"name":"some-agent"}'

Example response: 

{
  "id": 1,
  "name": "agent-1",
  "config_project": {
    "id": 20,
    "description": "",
    "name": "test",
    "name_with_namespace": "Administrator / test",
    "path": "test",
    "path_with_namespace": "root/test",
    "created_at": "2022-03-20T20:42:40.221Z"
  },
  "created_at": "2022-04-20T20:42:40.221Z",
  "created_by_user_id": 42
}

Delete a registered agent

Deletes an existing agent registration.

You must have at least the Maintainer role to use this endpoint. 

DELETE /projects/:id/cluster_agents/:agent_id

Parameters:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user
agent_id integer yes ID of the agent

Example request: 

curl --request DELETE --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/1

List tokens for an agent

{{< history >}}

{{< /history >}}

Returns a list of active tokens for an agent.

You must have at least the Developer role to use this endpoint. 

GET /projects/:id/cluster_agents/:agent_id/tokens

Supported attributes:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user.
agent_id integer or string yes ID of the agent.

Response:

The response is a list of tokens with the following fields:

Attribute Type Description
id integer ID of the token.
name string Name of the token.
description string or null Description of the token.
agent_id integer ID of the agent the token belongs to.
status string The status of the token. Valid values are active and revoked.
created_at string ISO8601 datetime when the token was created.
created_by_user_id string User ID of the user who created the token.

Example request: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/tokens"

Example response: 

[
  {
    "id": 1,
    "name": "abcd",
    "description": "Some token",
    "agent_id": 5,
    "status": "active",
    "created_at": "2022-03-25T14:12:11.497Z",
    "created_by_user_id": 1
  },
  {
    "id": 2,
    "name": "foobar",
    "description": null,
    "agent_id": 5,
    "status": "active",
    "created_at": "2022-03-25T14:12:11.497Z",
    "created_by_user_id": 1
  }
]

{{< alert type=”note” >}}

The last_used_at field for a token is only returned when getting a single agent token.

{{< /alert >}}

Get a single agent token

{{< history >}}

{{< /history >}}

Gets a single agent token.

You must have at least the Developer role to use this endpoint.

Returns a 404 if the agent token has been revoked. 

GET /projects/:id/cluster_agents/:agent_id/tokens/:token_id

Supported attributes:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user.
agent_id integer yes ID of the agent.
token_id integer yes ID of the token.

Response:

The response is a single token with the following fields:

Attribute Type Description
id integer ID of the token.
name string Name of the token.
description string or null Description of the token.
agent_id integer ID of the agent the token belongs to.
status string The status of the token. Valid values are active and revoked.
created_at string ISO8601 datetime when the token was created.
created_by_user_id string User ID of the user who created the token.
last_used_at string or null ISO8601 datetime when the token was last used.

Example request: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/token/1"

Example response: 

{
  "id": 1,
  "name": "abcd",
  "description": "Some token",
  "agent_id": 5,
  "status": "active",
  "created_at": "2022-03-25T14:12:11.497Z",
  "created_by_user_id": 1,
  "last_used_at": null
}

Create an agent token

{{< history >}}

  • Introduced in GitLab 15.0.
  • Two-token limit introduced in GitLab 16.1 with a flag named cluster_agents_limit_tokens_created.
  • Two-token limit generally available in GitLab 16.2. Feature flag cluster_agents_limit_tokens_created removed.

{{< /history >}}

Creates a new token for an agent.

You must have at least the Maintainer role to use this endpoint.

An agent can have only two active tokens at one time. 

POST /projects/:id/cluster_agents/:agent_id/tokens

Supported attributes:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user.
agent_id integer yes ID of the agent.
name string yes Name for the token.
description string no Description for the token.

Response:

The response is the new token with the following fields:

Attribute Type Description
id integer ID of the token.
name string Name of the token.
description string or null Description of the token.
agent_id integer ID of the agent the token belongs to.
status string The status of the token. Valid values are active and revoked.
created_at string ISO8601 datetime when the token was created.
created_by_user_id string User ID of the user who created the token.
last_used_at string or null ISO8601 datetime when the token was last used.
token string The secret token value.

{{< alert type=”note” >}}

The token is only returned in the response of the POST endpoint and cannot be retrieved afterwards.

{{< /alert >}}

Example request: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/tokens" \
    -H "Content-Type:application/json" \
    -X POST --data '{"name":"some-token"}'

Example response: 

{
  "id": 1,
  "name": "abcd",
  "description": "Some token",
  "agent_id": 5,
  "status": "active",
  "created_at": "2022-03-25T14:12:11.497Z",
  "created_by_user_id": 1,
  "last_used_at": null,
  "token": "qeY8UVRisx9y3Loxo1scLxFuRxYcgeX3sxsdrpP_fR3Loq4xyg"
}

Revoke an agent token

{{< history >}}

{{< /history >}}

Revokes an agent token.

You must have at least the Maintainer role to use this endpoint. 

DELETE /projects/:id/cluster_agents/:agent_id/tokens/:token_id

Supported attributes:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user.
agent_id integer yes ID of the agent.
token_id integer yes ID of the token.

Example request: 

curl --request DELETE --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/tokens/1

Receptive agents

{{< details >}}

  • Tier: Ultimate
  • Offering: GitLab Self-Managed

{{< /details >}}

{{< history >}}

{{< /history >}}

Receptive agents allow GitLab to integrate with Kubernetes clusters that cannot establish a network connection to the GitLab instance, but can be connected to by GitLab.

List URL configurations for a receptive agent

Returns a list of URL configurations for an agent.

You must have at least the Developer role to use this endpoint. 

GET /projects/:id/cluster_agents/:agent_id/url_configurations

Supported attributes:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user.
agent_id integer or string yes ID of the agent.

Response:

The response is a list of URL configurations with the following fields:

Attribute Type Description
id integer ID of the URL configuration.
agent_id integer ID of the agent the URL configuration belongs to.
url string URL for this URL configuration.
public_key string (optional) Base64-encoded public key if JWT authentication is used.
client_cert string (optional) Client certificate in PEM format if mTLS authentication is used.
ca_cert string (optional) CA certificate in PEM format to verify the agent endpoint.
tls_host string (optional) TLS host name to verify the server name in agent endpoint.

Example request: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/url_configurations"

Example response: 

[
  {
    "id": 1,
    "agent_id": 5,
    "url": "grpcs://agent.example.com:4242",
    "public_key": "..."
  }
]

{{< alert type=”note” >}}

Either public_key or client_cert is set, but never both.

{{< /alert >}}

Get a single agent URL configuration

Gets a single agent URL configuration.

You must have at least the Developer role to use this endpoint. 

GET /projects/:id/cluster_agents/:agent_id/url_configurations/:url_configuration_id

Supported attributes:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user.
agent_id integer yes ID of the agent.
url_configuration_id integer yes ID of the URL configuration.

Response:

The response is a single URL configuration with the following fields:

Attribute Type Description
id integer ID of the URL configuration.
agent_id integer ID of the agent the URL configuration belongs to.
url string Agent URL for this URL configuration.
public_key string (optional) Base64-encoded public key if JWT authentication is used.
client_cert string (optional) Client certificate in PEM format if mTLS authentication is used.
ca_cert string (optional) CA certificate in PEM format to verify the agent endpoint.
tls_host string (optional) TLS host name to verify the server name in agent endpoint.

Example request: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/url_configurations/1"

Example response: 

{
  "id": 1,
  "agent_id": 5,
  "url": "grpcs://agent.example.com:4242",
  "public_key": "..."
}

{{< alert type=”note” >}}

Either public_key or client_cert is set, but never both.

{{< /alert >}}

Create an agent URL configuration

Creates a new URL configuration for an agent.

You must have at least the Maintainer role to use this endpoint.

An agent can have only one URL configuration at the time. 

POST /projects/:id/cluster_agents/:agent_id/url_configurations

Supported attributes:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user.
agent_id integer yes ID of the agent.
url string yes Agent URL for this URL configuration.
client_cert string no Client certificate in PEM format if mTLS authentication should be used. Must be provided with client_key.
client_key string no Client key in PEM format if mTLS authentication should be used. Must be provided with client_cert.
ca_cert string no CA certificate in PEM format to verify the agent endpoint.
tls_host string no TLS host name to verify the server name in agent endpoint.

Response:

The response is the new URL configuration with the following fields:

Attribute Type Description
id integer ID of the URL configuration.
agent_id integer ID of the agent the URL configuration belongs to.
url string Agent URL for this URL configuration.
public_key string (optional) Base64-encoded public key if JWT authentication is used.
client_cert string (optional) Client certificate in PEM format if mTLS authentication is used.
ca_cert string (optional) CA certificate in PEM format to verify the agent endpoint.
tls_host string (optional) TLS host name to verify the server name in agent endpoint.

Example request to create a URL configuration with a JWT token: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/url_configurations" \
    -H "Content-Type:application/json" \
    -X POST --data '{"url":"grpcs://agent.example.com:4242"}'

Example response for JWT authentication: 

{
  "id": 1,
  "agent_id": 5,
  "url": "grpcs://agent.example.com:4242",
  "public_key": "..."
}

Example request to create a URL configuration using mTLS with a client certificate and key from the files client.pem and client-key.pem: 

curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/url_configurations" \
    -H "Content-Type:application/json" \
    -X POST --data '{"url":"grpcs://agent.example.com:4242", "client_cert":"'"$(awk -v ORS='\\n' '1' client.pem)"'", "client_key": "'"$(awk -v ORS='\\n' '1' client-key.pem)"'"}'

Example response for mTLS: 

{
  "id": 1,
  "agent_id": 5,
  "url": "grpcs://agent.example.com:4242",
  "client_cert": "..."
}

{{< alert type=”note” >}}

If the client_cert and client_key are not provided, a private-public key pair is generated and JWT authentication is used instead of mTLS.

{{< /alert >}}

Delete an agent URL configuration

Deletes an agent URL configuration.

You must have at least the Maintainer role to use this endpoint. 

DELETE /projects/:id/cluster_agents/:agent_id/url_configurations/:url_configuration_id

Supported attributes:

Attribute Type Required Description
id integer or string yes ID or URL-encoded path of the project maintained by the authenticated user.
agent_id integer yes ID of the agent.
url_configuration_id integer yes ID of the URL configuration.

Example request: 

curl --request DELETE --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/20/cluster_agents/5/url_configurations/1