Open navClose nav

Clients

Get the currently registered clients by serial number

Retrieves a registered client endpoint by its serial number

Request URL

GET https://api.stackl.io/clients/{serial}/

A valid client certificate is required to able to access the REST API. See section Authentication

Parameters

Parameter Type Description
serial string The serial number of the certificate

Request Example

curl -X GET "https://api.stackl.io/clients/<serial number>" -H "accept: application/json"

Response Example

{
  "description": "Automation Endpoint",
  "role": "automation-endpoint",
  "fingerprint": "0000000000000",
  "serial": "<serial number>",
  "type": "client",
  "tenant": "<tenant>",
  "name": "<serial number>"
}

Get the currently registered clients by role

Retrieves the registered client endpoints by role.

Request URL

GET https://api.stackl.io/clients

A valid client certificate is required to able to access the REST API. See section Authentication

Parameters

Parameter Type Description
role string Type of role: proxy, administrator or automation-endpoint. See section Authentication

Request Example

curl -X GET "https://api.stackl.io/clients?role=proxy" -H "accept: application/json"

Response Example

{
  "result": [
    {
      "description": "Proxy Agent Production",
      "tags": [
        "production"
      ],
      "role": "proxy",
      "fingerprint": "0000000000000",
      "serial": "<serial number>",
      "type": "client",
      "tenant": "<tenant>",
      "name": "<serial number>"
    },
    {
      "description": "Proxy Common",
      "role": "proxy",
      "fingerprint": "0000000000000",
      "serial": "<serial number>",
      "type": "client",
      "tenant": "<tenant>",
      "name": "<serial number>"
    }
  ]
}

Delete a Client Endpoint

Delete a client endpoint by its serial number

Request URL

DELETE https://api.stackl.io/clients

A valid client certificate is required to able to access the REST API. See section Authentication

Parameters

Parameter Type Description
serial string The serial number of the certificate

Request Example

curl -X DELETE "https://api.stackl.io/clients/<serial number>" -H "accept: application/json"

Request Example

curl -X DELETE "https://api.stackl.io/stacks/instances/{stack_instance_id}/" -H "accept: application/json"

Response Example

{
  "message": "Client marked for delete",
  "return_code": 202
}

Assign a role, register or update a client endpoint

Assign a role, register or update a client endpoint

Request URL

POST https://api.stackl.io/clients

A valid client certificate is required to able to access the REST API. See section Authentication

Parameters

Parameter Type Description
payload json string Request Body

Optional you can assign a tag value, this tag value can then be used by the ProxyTag key ( see section Proxy Agent )

{
  "description": "Proxy Production",
  "tags": [
    "production"
  ],
  "role": "proxy",
  "fingerprint": "0000000000000",
  "serial": "<serial number>",
  "type": "client",
  "tenant": "<tenant",
  "name": "<serial number>"
}

Request Example

curl -X POST "https://api.stackl.io/clients" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"serial\": \"2C\", \"role\": \"administrator\", \"description\": \"Tenant Admin\", \"fingerprint\": \"0000000000000\"}"

Response Example

{
  "message": "Created",
  "return_code": 201
}

Last updated on August 23, 2018