Role bindings API
NOTE: Requests to the 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 role bindings
The /rolebindings
API endpoint provides HTTP GET access to role binding data.
Example
The following example demonstrates a request to the /rolebindings
API endpoint, resulting in a JSON array that contains role binding definitions.
curl -X GET \
http://127.0.0.1:8080/api/core/v2/namespaces/default/rolebindings \
-H "Authorization: Key $SENSU_API_KEY"
HTTP/1.1 200 OK
[
{
"subjects": [
{
"type": "Group",
"name": "readers"
}
],
"role_ref": {
"type": "Role",
"name": "read-only"
},
"metadata": {
"name": "readers-group-binding",
"namespace": "default",
"created_by": "admin"
}
}
]
API Specification
/rolebindings (GET) | |
---|---|
description | Returns the list of role bindings. |
example url | http://hostname:8080/api/core/v2/namespaces/default/rolebindings |
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 role binding
The /rolebindings
API endpoint provides HTTP POST access to create Sensu role bindings.
Example
In the following example, an HTTP POST request is submitted to the /rolebindings
API endpoint to create a role binding named readers-group-binding
.
The request returns a successful HTTP 201 Created
response.
curl -X POST \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"name": "development"
}' \
http://127.0.0.1:8080/api/core/v2/namespaces/default/rolebindings
HTTP/1.1 201 Created
API Specification
/rolebindings (POST) | |
---|---|
description | Creates a Sensu role binding. |
example URL | http://hostname:8080/api/core/v2/namespaces/default/rolebindings |
payload |
|
response codes |
|
Get a specific role binding
The /rolebindings/:rolebinding
API endpoint provides HTTP GET access to role binding data for specific :rolebinding
definitions, by role binding name
.
Example
In the following example, querying the /rolebindings/:rolebinding
API endpoint returns a JSON map that contains the requested :rolebinding
definition (in this example, for the :rolebinding
named readers-group-binding
).
curl -X GET \
http://127.0.0.1:8080/api/core/v2/namespaces/default/rolebindings/readers-group-binding \
-H "Authorization: Key $SENSU_API_KEY"
HTTP/1.1 200 OK
{
"subjects": [
{
"type": "Group",
"name": "readers"
}
],
"role_ref": {
"type": "Role",
"name": "read-only"
},
"metadata": {
"name": "readers-group-binding",
"namespace": "default",
"created_by": "admin"
}
}
API Specification
/rolebindings/:rolebinding (GET) | |
---|---|
description | Returns the specified role binding. |
example url | http://hostname:8080/api/core/v2/namespaces/default/rolebindings/readers-group-binding |
response type | Map |
response codes |
|
output |
|
Create or update a role binding
The /rolebindings/:rolebinding
API endpoint provides HTTP PUT access to create or update role binding data for specific :rolebinding
definitions, by role binding name
.
Example
In the following example, an HTTP PUT request is submitted to the /rolebindings/:rolebinding
API endpoint to create the role binding dev-binding
.
The request returns a successful HTTP 201 Created
response.
curl -X PUT \
-H "Authorization: Key $SENSU_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"subjects": [
{
"type": "Group",
"name": "devs"
}
],
"role_ref": {
"type": "Role",
"name": "workflow-creator"
},
"metadata": {
"name": "dev-binding",
"namespace": "default"
}
}' \
http://127.0.0.1:8080/api/core/v2/namespaces/default/rolebindings/dev-binding
HTTP/1.1 201 Created
API Specification
/rolebindings/:rolebinding (PUT) | |
---|---|
description | Creates or updates a Sensu role binding. |
example URL | http://hostname:8080/api/core/v2/namespaces/default/rolebindings/dev-binding |
payload |
|
response codes |
|
Delete a role binding
The /rolebindings/:rolebinding
API endpoint provides HTTP DELETE access to delete a role binding from Sensu (specified by the role binding name).
Example
The following example shows a request to the /rolebindings/:rolebinding
API endpoint to delete the role binding dev-binding
, resulting in a successful HTTP 204 No Content
response.
curl -X DELETE \
http://127.0.0.1:8080/api/core/v2/namespaces/default/rolebindings/dev-binding \
-H "Authorization: Key $SENSU_API_KEY"
HTTP/1.1 204 No Content
API Specification
/rolebindings/:rolebinding (DELETE) | |
---|---|
description | Removes the specified role binding from Sensu. |
example url | http://hostname:8080/api/core/v2/namespaces/default/rolebindings/dev-binding |
response codes |
|