Skip to content
forgit api docs

Create an agent token

POST
/api/v4/projects/{id}/cluster_agents/{agent_id}/tokens

Creates a token for an agent. You must have the Maintainer or Owner role to use this endpoint. An agent can have only two active tokens at one time.

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

agent_id
required
integer

The ID of an agent

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

The name for the token

string
nullable
description

The description for the token

string
nullable
Examplegenerated
{
  "name": "example",
  "description": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
id
integer format: int64
name
string
description
string
agent_id
integer format: int64
status
string
created_at
string format: date-time
created_by_user_id
integer format: int64
last_used_at
string format: date-time
token
string
Example
{
  "id": 1,
  "agent_id": 1,
  "created_by_user_id": 1
}

400

Section titled “400”

Bad Request

404

Section titled “404”

Not Found