Skip to content
forgit api docs

List all agents

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

Lists all agents registered for the project. You must have the Developer, Maintainer, or Owner role to use this endpoint.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
One of:
string

The ID or URL-encoded path of the project

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 nullable

Current page number

Example
1
per_page
integer
default: 20 nullable

Number of items per page

Example
20

Responses

Section titled “Responses”

200

Section titled “200”

OK

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

Section titled “400”

Bad Request

404

Section titled “404”

Not Found