Agent

This endpoint is used to create, update, search or delete job agents for a Terrakube organization.

You need to be part of the administrator group to work with this endpoint

Entity fields:

Path	Type	Description
data.type	string	Should be "agent"
data.attributes.name	string	Agent pool name
data.attributes.description	string	Agent pool description
data.attributes.url	string	URL where the executor component will be available. Example: http://terrakube-executor-service.self-hosted-executor

Example:

POST {{terrakubeApi}}/api/v1/organization/{{organizationId}}/agent
{
  "data": {
    "type": "agent",
    "attributes": {
      "name": "sample-agent",
      "url": "http://localhost:8090",
      "description": "This is a sample agent"
    }
  }
}

Supported Operations:

get

Returns the collection of agent

Path parameters

organizationIdstringRequired

organization Identifier

Query parameters

page[number]integerOptional

page[size]integerOptional

Responses

200

Successful response

application/vnd.api+json

get/organization/{organizationId}/agent

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/agent HTTP/1.1
Accept: */*

200

Successful response

{
  "data": []
}

post

Creates an item of type agent

Path parameters

organizationIdstringRequired

organization Identifier

Body

application/vnd.api+json

Responses

201

Successful response

application/vnd.api+json

post/organization/{organizationId}/agent

HTTPcURLJavaScriptPython

POST /api/v1/organization/{organizationId}/agent HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 168

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text",
      "url": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

201

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text",
      "url": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

get

Returns an instance of type agent

Path parameters

organizationIdstringRequired

organization Identifier

agentIdstringRequired

agent Identifier

Query parameters

Responses

200

Successful response

application/vnd.api+json

get/organization/{organizationId}/agent/{agentId}

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/agent/{agentId} HTTP/1.1
Accept: */*

200

Successful response

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text",
      "url": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

delete

Deletes an instance of type agent

Path parameters

organizationIdstringRequired

organization Identifier

agentIdstringRequired

agent Identifier

Responses

204

Successful response

No content

delete/organization/{organizationId}/agent/{agentId}

HTTPcURLJavaScriptPython

DELETE /api/v1/organization/{organizationId}/agent/{agentId} HTTP/1.1
Accept: */*

204

Successful response

No content

patch

Modifies an instance of type agent

Path parameters

organizationIdstringRequired

organization Identifier

agentIdstringRequired

agent Identifier

Body

application/vnd.api+json

Responses

204

Successful response

No content

patch/organization/{organizationId}/agent/{agentId}

HTTPcURLJavaScriptPython

PATCH /api/v1/organization/{organizationId}/agent/{agentId} HTTP/1.1
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 168

{
  "data": {
    "type": "text",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text",
      "url": "text"
    },
    "relationships": {
      "organization": {
        "id": "text",
        "type": "organization"
      }
    }
  }
}

204

Successful response

No content