Cluster role bindings API
NOTE: Requests to the cluster role bindings API require you to authenticate with a Sensu access token or API key.
The code examples in this document use the environment variable $SENSU_API_KEY
to represent a valid API key in API requests.
Get all cluster role bindings
The /clusterrolebindings
API endpoint provides HTTP GET access to cluster role binding data.
Example
The following example demonstrates a request to the /clusterrolebindings
API endpoint, resulting in a JSON array that contains cluster role binding definitions.
curl -X GET \
http://127.0.0.1:8080/api/core/v2/clusterrolebindings \
-H "Authorization: Key $SENSU_API_KEY"
HTTP/1.1 200 OK
[
{
"subjects": [
{
"type": "Group",
"name": "cluster-admins"
}
],
"role_ref": {
"type": "ClusterRole",
"name": "cluster-admin"
},
"metadata": {
"name": "cluster-admin",
"created_by": "admin"
}
},
{
"subjects": [
{
"type": "Group",
"name": "system:agents"
}
],
"role_ref": {
"type": "ClusterRole",
"name": "system:agent"
},
"metadata": {
"name": "system:agent",
"created_by": "admin"
}
}
]
API Specification
/clusterrolebindings (GET) | |
---|---|
description | Returns the list of cluster role bindings. |
example url | http://hostname:8080/api/core/v2/clusterrolebindings |
pagination | This endpoint supports pagination using the limit and continue query parameters. |
response filtering | This endpoint supports API response filtering. |
response type | Array |
response codes |
|
output |
|
Create a new cluster role binding
The /clusterrolebindings
API endpoint provides HTTP POST access to create a cluster role binding.
Example
In the following example, an HTTP POST request is submitted to the /clusterrolebindings
API endpoint to create a cluster role binding that assigns the cluster-admin
cluster role to the user bob
.
The request includes the cluster role binding definition in the request body and returns a successful HTTP 200 OK
response and the created cluster role binding definition.
curl -X POST \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"subjects": [
{
"type": "User",
"name": "bob"
}
],
"role_ref": {
"type": "ClusterRole",
"name": "cluster-admin"
},
"metadata": {
"name": "bob-binder"
}
}' \
http://127.0.0.1:8080/api/core/v2/clusterrolebindings
HTTP/1.1 201 Created
API Specification
/clusterrolebindings (POST) | |
---|---|
description | Creates a Sensu cluster role binding. |
example URL | http://hostname:8080/api/core/v2/clusterrolebindings |
payload |
|
response codes |
|
Get a specific cluster role binding
The /clusterrolebindings/:clusterrolebinding
API endpoint provides HTTP GET access to cluster role binding data for specific :clusterrolebinding
definitions, by cluster role binding name
.
Example
In the following example, querying the /clusterrolebindings/:clusterrolebinding
API endpoint returns a JSON map that contains the requested :clusterrolebinding
definition (in this example, for the :clusterrolebinding
named bob-binder
).
curl -X GET \
http://127.0.0.1:8080/api/core/v2/clusterrolebindings/bob-binder \
-H "Authorization: Key $SENSU_API_KEY"
HTTP/1.1 200 OK
{
"subjects": [
{
"type": "User",
"name": "bob"
}
],
"role_ref": {
"type": "ClusterRole",
"name": "cluster-admin"
},
"metadata": {
"name": "bob-binder",
"created_by": "admin"
}
}
API Specification
/clusterrolebindings/:clusterrolebinding (GET) | |
---|---|
description | Returns the specified cluster role binding. |
example url | http://hostname:8080/api/core/v2/clusterrolebindings/bob-binder |
response type | Map |
response codes |
|
output |
|
Create or update a cluster role binding
The /clusterrolebindings/:clusterrolebinding
API endpoint provides HTTP PUT access to create or update a cluster role binding, by cluster role binding name
.
Example
In the following example, an HTTP PUT request is submitted to the /clusterrolebindings/:clusterrolebinding
API endpoint to create a cluster role binding that assigns the cluster-admin
cluster role to users in the group ops
.
The request includes the cluster role binding definition in the request body and returns a successful HTTP 200 OK
response and the created cluster role binding definition.
curl -X PUT \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"subjects": [
{
"type": "Group",
"name": "ops"
}
],
"role_ref": {
"type": "ClusterRole",
"name": "cluster-admin"
},
"metadata": {
"name": "ops-group-binder"
}
}' \
http://127.0.0.1:8080/api/core/v2/clusterrolebindings/ops-group-binder
HTTP/1.1 201 Created
API Specification
/clusterrolebindings/:clusterrolebinding (PUT) | |
---|---|
description | Creates or updates the specified Sensu cluster role binding. |
example URL | http://hostname:8080/api/core/v2/clusterrolebindings/ops-group-binder |
payload |
|
response codes |
|
Update a cluster role binding with PATCH
The /clusterrolebindings/:clusterrolebinding
API endpoint provides HTTP PATCH access to update :clusterrolebinding
definitions, specified by cluster role binding name.
NOTE: You cannot change a resource’s name
or namespace
with a PATCH request.
Use a PUT request instead.
Also, you cannot add elements to an array with a PATCH request — you must replace the entire array.
Example
In the following example, an HTTP PATCH request is submitted to the /clusterrolebindings/:clusterrolebinding
API endpoint to update the subjects array for the ops-group-binder
cluster role binding, resulting in an HTTP 200 OK
response and the updated cluster role binding definition.
We support JSON merge patches, so you must set the Content-Type
header to application/merge-patch+json
for PATCH requests.
curl -X PATCH \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/merge-patch+json' \
-d '{
"subjects": [
{
"type": "Group",
"name": "ops_team_1"
},
{
"type": "Group",
"name": "ops_team_2"
}
]
}' \
http://127.0.0.1:8080/api/core/v2/clusterrolebindings/ops-group-binder
HTTP/1.1 200 OK
API Specification
/clusterrolebindings/:clusterrolebinding (PATCH) | |
---|---|
description | Updates the specified Sensu cluster role binding. |
example URL | http://hostname:8080/api/core/v2/clusterrolebindings/ops-group-binder |
payload |
|
response codes |
|
Delete a cluster role binding
The /clusterrolebindings/:clusterrolebinding
API endpoint provides HTTP DELETE access to delete a cluster role binding from Sensu (specified by the cluster role binding name).
Example
The following example shows a request to the /clusterrolebindings/:clusterrolebinding
API endpoint to delete the cluster role binding ops-binding
, resulting in a successful HTTP 204 No Content
response.
curl -X DELETE \
-H "Authorization: Key $SENSU_API_KEY" \
http://127.0.0.1:8080/api/core/v2/clusterrolebindings/ops-binding
HTTP/1.1 204 No Content
API Specification
/clusterrolebindings/:clusterrolebinding (DELETE) | |
---|---|
description | Removes a cluster role binding from Sensu (specified by the cluster role binding name). |
example url | http://hostname:8080/api/core/v2/clusterrolebindings/ops-binding |
response codes |
|