Create an agent URL configuration

POST

/api/v4/projects/{id}/cluster_agents/{agent_id}/url_configurations

• GitLab REST API

Creates an agent URL configuration. You must have the Maintainer or Owner role to use this endpoint. An agent can have only one URL configuration at the time. This feature was introduced in GitLab 17.4.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

agent_id

required

integer

The ID of an agent

Request Body ^required

Media type application/json

object

url

required

The url where the receptive agent is listening

string

nullable

client_cert

The client certificate in PEM format for mTLS

string

nullable

client_key

The client key in PEM format for mTLS

string

nullable

ca_cert

The CA certificate in PEM format for TLS validation

string

nullable

tls_host

The host name for TLS validation

string

nullable

Example ^generated

{
  "url": "example",
  "client_cert": "example",
  "client_key": "example",
  "ca_cert": "example",
  "tls_host": "example"
}

Responses

201

Created

Media type application/json

object

id

integer format: int64

agent_id

integer format: int64

url

string

public_key

string

client_cert

string

ca_cert

string

tls_host

string

Example

{
  "id": 1,
  "agent_id": 1
}

400

Bad Request

404

Not Found