Me API
Gets information about the current token.
The JSON is the same as the data object in the oauth2 endpoint's response.
| Path | Method | Protected |
|---|---|---|
/v1/me/token | GET | Yes |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}List all environments that are visible to the current user, either directly or through shares.
| Path | Method | Protected |
|---|---|---|
/v1/me/visible-environments | GET | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| account_email | string | No | - |
| app_name | string | No | - |
| env_name | string | No | - |
Example Response JSON
{
"values": [
{
"environment": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"name": "string",
"compatibilityCheck": true,
"versionCheck": true,
"securityOverrides": true,
"rolesFromActiveShares": [
"admin"
],
"currentDeployment": {
"revision": 0,
"deploymentRevision": 0,
"deploymentVersion": "string",
"deploymentHash": "string"
}
},
"application": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"account": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "string"
}
}
]
}Me API Errors
| Status Code | Description | Body |
|---|---|---|
| 400 | Invalid request, returning with a list of issues detected in the request | {"code":"string","errors":["string"]} |
| 401 | Unauthorized request | {"code":"string","error":"string"} |
| 403 | Forbidden Request | {"code":"string","error":"string"} |
| 404 | Entity not found | {"code":"string","error":"string"} |
| 409 | {"code":"string","error":"string"} | |
| 422 | Limits of the plan exceeded | {"code":"string","error":"string"} |
| 500 | Internal server error | {"code":"string","error":"string"} |