Create an agent

POST

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

• GitLab REST API

Creates an agent for the project. You must have the Maintainer or Owner role to use this endpoint.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

Request Body^required

Media typeapplication/json

object

name

required

The name of the agent

string

nullable

Example^generated

{
  "name": "example"
}

Responses

201

Created

Media typeapplication/json

object

id

integer format: int64

name

string

config_project

object

id

integer format: int64

description

string

name

string

name_with_namespace

string

path

string

path_with_namespace

string

created_at

string format: date-time

created_at

string format: date-time

created_by_user_id

integer format: int64

is_receptive

boolean

Example

{
  "id": 1,
  "config_project": {
    "id": 1,
    "description": "desc",
    "name": "project1",
    "name_with_namespace": "John Doe / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z"
  },
  "created_by_user_id": 1
}

400

Bad Request

404

Not Found