Clusters

Endpoints related to managing infrastructure clusters.

List Clusters

Requires the clusters-view capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses

200

Returns a list of clusters.

default

General error response from the platform

get/v1/infrastructure/clusters

Response samples

200
default

application/json

{"data": [{"id": "string",
"identifier": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
]
}

Create Cluster

Requires the clusters-manage capability.

SecuritybearerAuth and hubAuth

Request

Request Body schema: application/json

Parameters for creating a new cluster.

identifier

required

string (Identifier)

A human-readable identifier used to refer to a resource, where using the official ID may be inconvenient. The identifier is automatically tokenized from the name/relevant field of the resource if one is not provided. For example, a container named "My Container" will have the identifier of my-container and is automatically created by the platform.

The identifier does not have to be unique.

ACL (object) or null

Responses

201

Returns a cluster.

default

General error response from the platform

post/v1/infrastructure/clusters

Request samples

Payload

application/json

{"identifier": "string",
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
}
}

Response samples

201
default

application/json

{"data": {"id": "string",
"identifier": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
}

Get Cluster

Gets a Cluster. Requires the clusters-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

clusterId

required

string

The ID of the requested cluster.

Responses

200

Returns a cluster.

default

General error response from the platform

get/v1/infrastructure/clusters/{clusterId}

Response samples

200
default

application/json

{"data": {"id": "string",
"identifier": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
}

Update Cluster

Requires the clusters-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

clusterId

required

string

The ID of the requested cluster.

Request Body schema: application/json

Parameters for updating a cluster.

object

Responses

200

Returns a cluster.

default

General error response from the platform

patch/v1/infrastructure/clusters/{clusterId}

Request samples

Payload

application/json

{ }

Response samples

200
default

application/json

{"data": {"id": "string",
"identifier": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
}

Delete Cluster

Requires the clusters-manage capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

clusterId

required

string

The ID of the requested cluster.

Responses

202

Returns a job descriptor.

default

General error response from the platform

delete/v1/infrastructure/clusters/{clusterId}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

Update Cluster Access

Requires the clusters-manage capability. If an ACL is present, requires the manage privilege.

SecuritybearerAuth and hubAuth

Request

path Parameters

clusterId

required

string

The ID of the requested cluster.

Request Body schema: application/json

Parameters for updating a cluster.

ACL (object) or null

Responses

200

Returns a cluster.

default

General error response from the platform

patch/v1/infrastructure/clusters/{clusterId}/access

Request samples

Payload

application/json

{"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
}
}

Response samples

200
default

application/json

{"data": {"id": "string",
"identifier": "string",
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
}

➔ Next to Providers