Get all cluster access requests
This page will soon be available only on the dedicated Dynatrace Managed Documentation site. Update your bookmarks.
This API call gets a list of all current cluster access requests, including user, access role, access duration, and state of the request.
Authentication
To execute this request, you need one of the following API-Token scopes:
- Cluster token management (
ClusterTokenManagement) - Service Provider API (
ServiceProviderAPI) - Nodekeeper access for node management (
Nodekeeper)
To learn how to obtain and use it, see Cluster API - Authentication.
Endpoint
/api/cluster/v2/remoteaccess/requests
Parameters
The request doesn't provide any configurable parameters.
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | AccessRequestData[] | Successful |
| 403 | - | Approving remote access request is disabled |
Response body objects
The ResponseBody object
The AccessRequestData object
Access Request data
| Element | Type | Description |
|---|---|---|
| requestId | string | Request id |
| userId | string | User id |
| reason | string | Request reason description |
| requestedDays | integer | For how many days access is requested |
| role | string | Requested role
|
| createdTimestamp | integer | Access request created at (timestamp) |
| expirationTimestamp | integer | Access expires at (timestamp) |
| state | string | Access request state
|
| stateModifiedByUser | string | Access request state was modified by user |
Response body JSON model
1[2 {3 "requestId": "string",4 "userId": "string",5 "reason": "string",6 "requestedDays": 1,7 "role": "devops-admin",8 "createdTimestamp": 1,9 "expirationTimestamp": 1,10 "state": "ACCEPTED",11 "stateModifiedByUser": "string"12 }13]
Example
In this example you request a cluster (myManaged.cluster.com) to return a list of all current remote access requests.
Curl
1curl -X GET "https://myManaged.cluster.com/api/cluster/v2/remoteaccess/requests"2 -H "accept: application/json"
Request URL
1https://myManaged.cluster.com/api/cluster/v2/remoteaccess/requests
Response body
1{2 "requestId":"7a397770-86b7-473b-b23e-4a07d79f2eff",3 "userId":"john.smith@dynatrace.com",4 "reason":"SUP-123456 Verifying cluster state after upgrade",5 "requestedDays":7,6 "role":"devops-admin",7 "createdTimestamp":1586452866661,8 "expirationTimestamp":null,9 "state":"PENDING",10 "stateModifiedByUser":null11}
Response code
200