{
"opencollection": "1.0.0",
"info": {
"name": "Acquia Cloud API Documentation",
"version": "2.0.0"
},
"items": [
{
"info": {
"name": "Current system health",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return the current system health status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/"
},
"docs": "Returns status checks for system database, configuration and registry."
}
]
},
{
"info": {
"name": "Account",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns details about your account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account"
},
"docs": "Returns details about your account."
},
{
"info": {
"name": "Returns whether your account has access to a specific application permission.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/applications/:applicationUuid/has-permission",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "permission",
"value": "deploy to prod",
"type": "query",
"description": "Specifies the permission you wish to check access for."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account has access to a specific application permission."
},
{
"info": {
"name": "Returns whether your account is an administrator for an application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/applications/:applicationUuid/is-admin",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account is an administrator for an application."
},
{
"info": {
"name": "Returns whether your account is the owner for an application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/applications/:applicationUuid/is-owner",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account is the owner for an application."
},
{
"info": {
"name": "Marks an application as recently viewed.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/account/applications/:applicationUuid/actions/mark-recent",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Marks an application as recently viewed. UUIDs and timestamps of recent applications are present in the \"account\" endpoint."
},
{
"info": {
"name": "Stars an application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/account/applications/:applicationUuid/actions/star",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Stars an application. UUIDs of starred applications are present in the \"account\" endpoint."
},
{
"info": {
"name": "Removes an application from the user's starred list.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/account/applications/:applicationUuid/actions/unstar",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes an application from the user's starred list. UUIDs of starred applications are present in the \"account\" endpoint."
},
{
"info": {
"name": "Returns the drush aliases as a compressed archive download.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/drush-aliases/download",
"params": [
{
"name": "version",
"value": "8",
"type": "query",
"description": "Specifies the drush aliases formatting, either 8 (example.aliases.drushrc.php) or 9 (example.site.yaml)"
}
]
},
"docs": "Returns the drush aliases as a compressed archive download."
},
{
"info": {
"name": "Returns a list of Cloud IDEs associated with the current user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/ides"
},
"docs": "Returns a list of Cloud IDEs associated with the current user."
},
{
"info": {
"name": "Gets a list of all organization admin and team invites that are pending for the current user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/invites",
"params": [
{
"name": "from",
"value": "2023-09-01",
"type": "query",
"description": "Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n"
},
{
"name": "to",
"value": "2023-09-29",
"type": "query",
"description": "Optionally specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-29`\n* `2023-09-29T00%3A00%3A00.000Z` (`2023-09-29T00:00:00.000Z`)\n"
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a list of all organization admin and team invites that are pending for the current user.\n\nFilterable fields:\n* `mail`\n* `token`\n* `author`\n\nSortable fields:\n* `mail`\n* `token`\n* `author`\n"
},
{
"info": {
"name": "Returns a list of messages associated with the current user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/messages",
"params": [
{
"name": "from",
"value": "2023-09-01",
"type": "query",
"description": "Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n"
},
{
"name": "to",
"value": "2023-09-29",
"type": "query",
"description": "Optionally specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-29`\n* `2023-09-29T00%3A00%3A00.000Z` (`2023-09-29T00:00:00.000Z`)\n"
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of messages associated with the current user.\n\nFilterable fields:\n* `title`\n* `message_type`\n* `display_mode`\n\nSortable fields:\n* `title`\n* `message_type`\n* `display_mode`\n"
},
{
"info": {
"name": "Returns whether your account is an administrator for an organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/organizations/:organizationUuid/is-admin",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account is an administrator for an organization."
},
{
"info": {
"name": "Returns whether your account is the owner for an organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/organizations/:organizationUuid/is-owner",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account is the owner for an organization."
},
{
"info": {
"name": "Verifies that the supplied password matches the current user's password.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/account/password",
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Verifies that the supplied password matches the current user's password."
},
{
"info": {
"name": "Gets a list of SSH keys associated with the current user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/ssh-keys",
"params": [
{
"name": "from",
"value": "2023-09-01",
"type": "query",
"description": "Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n"
},
{
"name": "to",
"value": "2023-09-29",
"type": "query",
"description": "Optionally specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-29`\n* `2023-09-29T00%3A00%3A00.000Z` (`2023-09-29T00:00:00.000Z`)\n"
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a list of SSH keys associated with the current user.\n\nFilterable fields:\n* `label`\n\nSortable fields:\n* `label`\n"
},
{
"info": {
"name": "Installs a new SSH key for the current user.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/account/ssh-keys",
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Installs a new SSH key for the current user."
},
{
"info": {
"name": "Get an SSH key associated with the currently-logged in user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/ssh-keys/:sshKeyUuid",
"params": [
{
"name": "sshKeyUuid",
"value": "981b7910-2fe9-11e9-b210-d663bd873d93",
"type": "path",
"description": "The SSH key entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get an SSH key associated with the currently-logged in user."
},
{
"info": {
"name": "Deletes an SSH key.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/account/ssh-keys/:sshKeyUuid",
"params": [
{
"name": "sshKeyUuid",
"value": "981b7910-2fe9-11e9-b210-d663bd873d93",
"type": "path",
"description": "The SSH key entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes an SSH key."
},
{
"info": {
"name": "Returns whether your account is an administrator for a subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/subscriptions/:subscriptionUuid/is-admin",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account is an administrator for a subscription."
},
{
"info": {
"name": "Returns whether your account is the owner for a subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/subscriptions/:subscriptionUuid/is-owner",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account is the owner for a subscription."
},
{
"info": {
"name": "Returns whether your account has access to a specific team permission.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/teams/:teamUuid/has-permission",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "permission",
"value": "deploy to prod",
"type": "query",
"description": "Specifies the permission you wish to check access for."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account has access to a specific team permission."
},
{
"info": {
"name": "Returns whether your account is an administrator for a team.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/teams/:teamUuid/is-admin",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account is an administrator for a team."
},
{
"info": {
"name": "Returns whether your account is the owner for a team.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/teams/:teamUuid/is-owner",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns whether your account is the owner for a team."
},
{
"info": {
"name": "Returns a list of metadata for API access tokens tied to your account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/tokens",
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of metadata for API access tokens tied to your account."
},
{
"info": {
"name": "Creates an API access token tied to your account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/account/tokens",
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates an API access token tied to your account."
},
{
"info": {
"name": "Return details about a specific token.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/account/tokens/:tokenUuid",
"params": [
{
"name": "tokenUuid",
"value": "882f3258-2fe9-11e9-b210-d663bd873d93",
"type": "path",
"description": "The token entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return details about a specific token."
},
{
"info": {
"name": "Revokes an access token.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/account/tokens/:tokenUuid",
"params": [
{
"name": "tokenUuid",
"value": "882f3258-2fe9-11e9-b210-d663bd873d93",
"type": "path",
"description": "The token entity's universally unique identifier."
},
{
"name": "tokenDeleteReason",
"value": "The quick brown fox jumped over the lazy dog.",
"type": "query",
"description": "Specifies the reason for the token revocation for future reference."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Revokes an access token. This action will prevent the access token from being able to authorize access to the API in the future."
}
]
},
{
"info": {
"name": "Agreements",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return a list of agreements.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/agreements"
},
"docs": "Returns a list of agreements you have been invited to accept or decline."
},
{
"info": {
"name": "Return a specific agreement by a provided UUID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/agreements/:agreementUuid",
"params": [
{
"name": "agreementUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return a specific agreement."
},
{
"info": {
"name": "Accepts a legal agreement by UUID.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/agreements/:agreementUuid/actions/accept",
"params": [
{
"name": "agreementUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Accepts a legal agreement."
},
{
"info": {
"name": "Declines a legal agreement by UUID.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/agreements/:agreementUuid/actions/decline",
"params": [
{
"name": "agreementUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Declines a legal agreement."
},
{
"info": {
"name": "Returns a list of users invited to action this agreement.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/agreements/:agreementUuid/invitees",
"params": [
{
"name": "agreementUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of users invited to action this agreement by UUID."
}
]
},
{
"info": {
"name": "Applications",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return a list of applications the current user has access to.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications",
"params": [
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Applications contains the code, files, and databases required to run sites. You have access to an application if you are a member of a team that has access to an application, or if you are an administrator or owner of the organization that the application belongs to. A subscription may contain one or more applications.\n\nFilterable fields:\n* `label`\n* `name` (Deprecated)\n* `organization_name`\n* `hosting` (Deprecated) Use URL encoded colon (%3A) to separate realm and sitegroup, e.g. "
},
{
"info": {
"name": "Return details about a specific application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "A specific application."
},
{
"info": {
"name": "Renames an application.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/applications/:applicationUuid",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Renames a specific application."
},
{
"info": {
"name": "Return application artifacts.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/artifacts",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of this application's build artifacts. Only available for Node.js applications.\n\nFilterable fields:\n* `created`\n* `name`\n\nSortable fields:\n* `created`\n* `name`\n"
},
{
"info": {
"name": "Return details about a specific artifact.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/artifacts/:artifactId",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "artifactId",
"value": "drupal8",
"type": "path",
"description": "An ID that uniquely identifies an artifact."
}
]
},
"docs": "A specific artifact.\n"
},
{
"info": {
"name": "Return application branches and release tags.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/code",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of branches and release (repository) tags in this application's version control system.\n\nFilterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Returns details about the Code Studio project for an application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/code-studio",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return details about the Code Studio project for an application."
},
{
"info": {
"name": "Creates the Code Studio project for an application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/code-studio",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates the Code Studio project for an application."
},
{
"info": {
"name": "Removes the Code Studio project from an application.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/applications/:applicationUuid/code-studio",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the Code Studio project from an application."
},
{
"info": {
"name": "Returns a list database names for the application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/databases",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Filterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Creates a database.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/databases",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This action will create a new database within each environment of the application."
},
{
"info": {
"name": "Drops (deletes) a database.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/applications/:applicationUuid/databases/:name",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "name",
"value": "drupal8",
"type": "path",
"description": "A name that uniquely identifies an entity."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This action will delete the database in ALL environments within this application."
},
{
"info": {
"name": "Erases (truncates) a database.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/databases/:name/actions/erase",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "name",
"value": "drupal8",
"type": "path",
"description": "A name that uniquely identifies an entity."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This action will delete all tables of the database in ALL environments within this application."
},
{
"info": {
"name": "Returns a list of email domains associated with the application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/email/domains",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of email domains associated with the application and domains that have been verified at the subscription level."
},
{
"info": {
"name": "Associates an email domain with an Application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/email/domains/:domainRegistrationUuid/actions/associate",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "domainRegistrationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The Domain Registration universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Associates an email domain with an Application."
},
{
"info": {
"name": "Disassociates an email domain with an Application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/email/domains/:domainRegistrationUuid/actions/disassociate",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "domainRegistrationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The Domain Registration universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Disassociates an email domain with an Application."
},
{
"info": {
"name": "Returns a list of Cloud IDEs associated with this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/ides",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Returns a list of Cloud IDEs associated with this application."
},
{
"info": {
"name": "Creates a new Cloud IDE.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/ides",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "label",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a new Cloud IDE."
},
{
"info": {
"name": "Returns a list of messages associated with this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/messages",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "from",
"value": "2023-09-01",
"type": "query",
"description": "Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n"
},
{
"name": "to",
"value": "2023-09-29",
"type": "query",
"description": "Optionally specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-29`\n* `2023-09-29T00%3A00%3A00.000Z` (`2023-09-29T00:00:00.000Z`)\n"
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Filterable fields:\n* `title`\n* `message_type`\n* `display_mode`\n\nSortable fields:\n* `title`\n* `message_type`\n* `display_mode`\n"
},
{
"info": {
"name": "Returns a list of notifications associated with this application by its UUID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/notifications",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of notifications associated with this application. A notification represents an item of work to be done, initiated by someone (typically the current user) associated with the application.\n\nFilterable fields:\n* `event`\n* `label`\n* `description`\n* `status`\n* `author`\n* `created_at`\n* `completed_at`\n\nSortable fields:\n* `event`\n* `label`\n* `description`\n* `status`\n* `author`\n* `created_at`\n* `completed_at`\n"
},
{
"info": {
"name": "Returns a list of permissions the user has for this application by its UUID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/permissions",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Returns a list of permissions the user has for this application."
},
{
"info": {
"name": "Returns a traversal endpoint for search entities for the application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/search",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Does not return any data. Allows traversal to search entity endpoints."
},
{
"info": {
"name": "Returns a collection of search configuration sets for an application",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/search/config-sets",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "A collection of search configuration sets for an application."
},
{
"info": {
"name": "Creates a search configuration set for an application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/search/config-sets",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "archive",
"type": "text",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a search configuration set for an application."
},
{
"info": {
"name": "Returns a search configuration set for an application",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/search/config-sets/:configurationSetId",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "configurationSetId",
"value": "ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78",
"type": "path",
"description": "An ID that uniquely identifies a configuration set."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "A specific search configuration set."
},
{
"info": {
"name": "Removes and deletes a specific search configuration set from an application.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/applications/:applicationUuid/search/config-sets/:configurationSetId",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "configurationSetId",
"value": "ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78",
"type": "path",
"description": "An ID that uniquely identifies a configuration set."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes and deletes a specific search configuration set from an application."
},
{
"info": {
"name": "Returns available settings for this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/settings",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Does not return any data. Allows traversal to settings groups endpoints."
},
{
"info": {
"name": "Returns the hosting settings for this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/settings/hosting",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the hosting settings for this application."
},
{
"info": {
"name": "Returns the legacy product keys for this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/settings/keys",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the legacy product keys for this application."
},
{
"info": {
"name": "Returns the remote administration settings for this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/settings/ra",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the remote administration settings for this application."
},
{
"info": {
"name": "Modifies the remote administration settings for an application.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/applications/:applicationUuid/settings/ra",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modifies the remote administration settings for an application."
},
{
"info": {
"name": "Returns the security policy settings for this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/settings/security",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the security policy settings for this application."
},
{
"info": {
"name": "Modifies the security policy settings for an application.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/applications/:applicationUuid/settings/security",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "allowed_ips",
"value": ""
},
{
"name": "tfa_required",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modifies the security policy settings for an application."
},
{
"info": {
"name": "Returns a list of application tags associated with this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/tags",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Returns a list of application tags associated with this application."
},
{
"info": {
"name": "Creates a new application tag.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/tags",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
},
{
"name": "color",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a new application tag."
},
{
"info": {
"name": "Deletes an application tag.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/applications/:applicationUuid/tags/:tagName",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "tagName",
"value": "green",
"type": "path",
"description": "The name of the application tag."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes an application tag."
},
{
"info": {
"name": "Returns a list of tasks associated with this application by its UUID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/tasks",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of tasks associated with this application. A task represents an item of work to be done, initiated by someone (typically the current user) associated with the application.\n\nFilterable fields:\n* `name`\n* `title`\n* `created`\n* `completed`\n* `started`\n\nSortable fields:\n* `name`\n* `title`\n* `created`\n* `completed`\n* `started`\n"
},
{
"info": {
"name": "Returns a list of teams associated with this application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/teams",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "from",
"value": "2023-09-01",
"type": "query",
"description": "Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n"
},
{
"name": "to",
"value": "2023-09-29",
"type": "query",
"description": "Optionally specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-29`\n* `2023-09-29T00%3A00%3A00.000Z` (`2023-09-29T00:00:00.000Z`)\n"
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of teams associated with this application by its UUID.\n\nFilterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Retrieves traversal links for detailed metrics on usage (views and visits) of your application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/metrics/usage",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves traversal links for an application's usage data."
},
{
"info": {
"name": "Retrieves aggregate usage data for an application, filterable by views or visits and by environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/metrics/usage/data",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `metric` - One of: {`views`, `visits`}\n* `environment`\n"
},
{
"info": {
"name": "Retrieves usage data (views or visits) for an application, broken down by environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/metrics/usage/data-by-environment",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `metric` - One of: {`views`, `visits`}\n* `environment`\n"
},
{
"info": {
"name": "Retrieves aggregate usage metric data (views or visits) for an application..",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/metrics/usage/:usageMetric",
"params": [
{
"name": "usageMetric",
"value": "views",
"type": "path",
"description": "A usage data metric type."
},
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `environment`\n"
},
{
"info": {
"name": "Retrieves views data for an application, broken down by environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/metrics/usage/views-by-environment",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `environment`\n"
},
{
"info": {
"name": "Retrieves visits data for an application, broken down by environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/metrics/usage/visits-by-environment",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `environment`\n"
},
{
"info": {
"name": "Returns a list of environments within this application by its UUID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/environments",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of environments within this application."
},
{
"info": {
"name": "Add a new continuous delivery environment to an application by the application UUID.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/applications/:applicationUuid/environments",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "label",
"value": ""
},
{
"name": "branch",
"value": ""
},
{
"name": "databases",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Add a new continuous delivery environment."
},
{
"info": {
"name": "Return application features.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationUuid/features",
"params": [
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of feature flags for this application.\n"
}
]
},
{
"info": {
"name": "Distributions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return a list of Drupal distributions.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/distributions",
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of Drupal distributions that are available for installation in an Acquia Cloud environment.\n"
},
{
"info": {
"name": "Return details about a specific Drupal distribution.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/distributions/:name",
"params": [
{
"name": "name",
"value": "drupal8",
"type": "path",
"description": "A name that uniquely identifies an entity."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "A specific distribution.\n"
}
]
},
{
"info": {
"name": "Environments",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return details about a specific environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return details about a specific environment.\n\nTo find your environment ID via API:\n\n1. Make a request to GET `/api/applications/[uuid]/environments`.\n2. Find the entry that matches your environment. If you don't know the application UUID, first make a request to GET `/api/applications`.\n\nTo find your environment ID via cloud.acquia.com:\n\n1. Open [https://cloud.acquia.com](https://cloud.acquia.com).\n2. Navigate to your application.\n3. Navigate to the environment.\n4. See the environment ID in the "
},
{
"info": {
"name": "Modifies configuration settings for an environment.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/environments/:environmentId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modifies configuration settings for an environment. Note that some settings cannot be configured for certain subscriptions."
},
{
"info": {
"name": "Deletes a CD environment.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a CD environment."
},
{
"info": {
"name": "Displays environment options.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/environments/:environmentId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Displays environment options."
},
{
"info": {
"name": "Clears the caches for one or more domains attached to this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/actions/clear-caches",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Clear caches for Varnish and Platform CDN (if Platform CDN is enabled)."
},
{
"info": {
"name": "Change the label for an environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/actions/change-label",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "label",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Change the label for an environment."
},
{
"info": {
"name": "Deploys an artifact to this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/artifacts/actions/switch",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "artifact_id",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deploys an artifact to this environment."
},
{
"info": {
"name": "Return a list of operating systems.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/operating-systems",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns a list of operating systems."
},
{
"info": {
"name": "Return a list of runtimes.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/available-runtimes",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns a list of available runtimes."
},
{
"info": {
"name": "Returns the CDN status for an environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/cdn",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the CDN status for an environment. The CDN must be enabled for the status to be displayed."
},
{
"info": {
"name": "Enables a CDN for an environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/cdn",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enables a CDN for an environment."
},
{
"info": {
"name": "Disables a CDN for an environment.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/cdn",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Disables a CDN for an environment."
},
{
"info": {
"name": "Returns a list of Cloud Actions.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/cloud-actions",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of Cloud Actions on an environment."
},
{
"info": {
"name": "Modifies an existing list of Cloud Actions.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/environments/:environmentId/cloud-actions",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modifies an existing list of Cloud Actions on an environment."
},
{
"info": {
"name": "Disables Cloud Actions.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/cloud-actions/actions/disable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Disables Cloud Actions on an environment."
},
{
"info": {
"name": "Enables Cloud Actions.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/cloud-actions/actions/enable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enables Cloud Actions on an environment."
},
{
"info": {
"name": "Resets Cloud Actions.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/cloud-actions/actions/reset",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Resets Cloud Actions to the default on an environment."
},
{
"info": {
"name": "Deploys code to this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/code",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deploys code to this environment."
},
{
"info": {
"name": "Switches code on this environment to a different branch or release tag.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/code/actions/switch",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Switches code on this environment to a different branch or release tag."
},
{
"info": {
"name": "Imports a site to this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/code/actions/import",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Imports a site to this environment."
},
{
"info": {
"name": "Return environment cron jobs.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/crons",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of the cron jobs on an environment."
},
{
"info": {
"name": "Creates a scheduled job with cron.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/crons",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a scheduled job with cron on an environment."
},
{
"info": {
"name": "Return details about a specific cron job.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/crons/:cronId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "cronId",
"value": "e10a665c-c9ec-4422-a82b-b32c82329f9d",
"type": "path",
"description": "An ID that uniquely identifies a cron job."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return details about a specific cron job by environment ID and cron job ID."
},
{
"info": {
"name": "Modify an existing scheduled job.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/environments/:environmentId/crons/:cronId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "cronId",
"value": "e10a665c-c9ec-4422-a82b-b32c82329f9d",
"type": "path",
"description": "An ID that uniquely identifies a cron job."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modify an existing scheduled job on an environment."
},
{
"info": {
"name": "Deletes a cron job.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/crons/:cronId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "cronId",
"value": "e10a665c-c9ec-4422-a82b-b32c82329f9d",
"type": "path",
"description": "An ID that uniquely identifies a cron job."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a cron job."
},
{
"info": {
"name": "Enables a cron job.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/crons/:cronId/actions/enable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "cronId",
"value": "e10a665c-c9ec-4422-a82b-b32c82329f9d",
"type": "path",
"description": "An ID that uniquely identifies a cron job."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enables a cron job."
},
{
"info": {
"name": "Disables a cron job.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/crons/:cronId/actions/disable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "cronId",
"value": "e10a665c-c9ec-4422-a82b-b32c82329f9d",
"type": "path",
"description": "An ID that uniquely identifies a cron job."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Disables a cron job."
},
{
"info": {
"name": "Returns a list of databases.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/databases",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of databases.\n\nFilterable fields:\n* `name`\n* `id`\n\nSortable fields:\n* `name`\n* `id`\n"
},
{
"info": {
"name": "Copies a database to this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/databases",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
},
{
"name": "source",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Copies a database to this environment."
},
{
"info": {
"name": "Return details about a specific database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/databases/:databaseName",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "databaseName",
"value": "my_db",
"type": "path",
"description": "The database name, typically lower snake case."
}
]
},
"docs": "Return details about a specific database."
},
{
"info": {
"name": "Returns PHP configuration details for this database.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/databases/:databaseName/php-config",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "databaseName",
"value": "my_db",
"type": "path",
"description": "The database name, typically lower snake case."
}
]
},
"docs": "Returns PHP configuration details for this database."
},
{
"info": {
"name": "Returns a list of backups.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/databases/:databaseName/backups",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "databaseName",
"value": "my_db",
"type": "path",
"description": "The database name, typically lower snake case."
},
{
"name": "from",
"value": "2019-10-01",
"type": "query",
"description": "(Use filter `from` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `to` query."
},
{
"name": "to",
"value": "2020-01-01",
"type": "query",
"description": "(Use filter `to` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `from` query."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of backups.\n\nFilterable fields:\n* `type`\n* `created` Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date.\n\nSortable fields:\n* `type`\n* `created`\n"
},
{
"info": {
"name": "Create a backup.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/databases/:databaseName/backups",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "databaseName",
"value": "my_db",
"type": "path",
"description": "The database name, typically lower snake case."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Create a backup."
},
{
"info": {
"name": "Return details about a specific backup.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/databases/:databaseName/backups/:backupId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "databaseName",
"value": "my_db",
"type": "path",
"description": "The database name, typically lower snake case."
},
{
"name": "backupId",
"value": "1",
"type": "path",
"description": "The database backup identifier."
}
]
},
"docs": "Return details about a specific backup."
},
{
"info": {
"name": "Deletes a database backup.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/databases/:databaseName/backups/:backupId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "databaseName",
"value": "my_db",
"type": "path",
"description": "The database name, typically lower snake case."
},
{
"name": "backupId",
"value": "1",
"type": "path",
"description": "The database backup identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a database backup."
},
{
"info": {
"name": "Downloads the database backup file.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/databases/:databaseName/backups/:backupId/actions/download",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "databaseName",
"value": "my_db",
"type": "path",
"description": "The database name, typically lower snake case."
},
{
"name": "backupId",
"value": "1",
"type": "path",
"description": "The database backup identifier."
}
]
},
"docs": "Downloads the database backup file."
},
{
"info": {
"name": "Restores this backup to the appropriate environment's database.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/databases/:databaseName/backups/:backupId/actions/restore",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "databaseName",
"value": "my_db",
"type": "path",
"description": "The database name, typically lower snake case."
},
{
"name": "backupId",
"value": "1",
"type": "path",
"description": "The database backup identifier."
}
]
},
"docs": "Restores this backup to the appropriate environment's database."
},
{
"info": {
"name": "Returns DNS configuration details for an environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/dns",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns environment DNS configuration information for apex domain and subdomains."
},
{
"info": {
"name": "Returns a list of domains.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/domains",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of domains.\n\nFilterable fields:\n* `hostname`\n\nSortable fields:\n* `hostname`\n"
},
{
"info": {
"name": "Adds a domain to the environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/domains",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "hostname",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds a domain to the environment."
},
{
"info": {
"name": "Clears the Varnish cache for one or more domains attached to this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/domains/actions/clear-varnish",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Clears the Varnish cache for one or more domains attached to this environment."
},
{
"info": {
"name": "Return details about a specific domain.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/domains/:domain",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "domain",
"value": "example.com",
"type": "path",
"description": "A domain name."
}
]
},
"docs": "Return details about a specific domain."
},
{
"info": {
"name": "Removes the domain from this environment.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/domains/:domain",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "domain",
"value": "example.com",
"type": "path",
"description": "A domain name."
}
]
},
"docs": "Removes the domain from this environment."
},
{
"info": {
"name": "Clears the Varnish cache for the specified domain.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/domains/:domain/actions/clear-varnish",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "domain",
"value": "example.com",
"type": "path",
"description": "A domain name."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Clears the Varnish cache for the specified domain."
},
{
"info": {
"name": "Clears the caches for the specified domain.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/domains/:domain/actions/clear-caches",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "domain",
"value": "example.com",
"type": "path",
"description": "A domain name."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Clear caches for Varnish and Platform CDN (if Platform CDN is enabled)."
},
{
"info": {
"name": "Returns details about the domain.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/domains/:domain/status",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "domain",
"value": "example.com",
"type": "path",
"description": "A domain name."
}
]
},
"docs": "Returns details about the domain."
},
{
"info": {
"name": "Return a list of Web EIPs.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/eips",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns a list of Web EIPs."
},
{
"info": {
"name": "Copies files to this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/files",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "source",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Copies files to this environment."
},
{
"info": {
"name": "Returns a list of log files for this environment available for download.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/logs",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns a list of log files for this environment available for download."
},
{
"info": {
"name": "Downloads the log file.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/logs/:logType",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "logType",
"value": "php-error",
"type": "path",
"description": "An ID that uniquely identifies a log type."
}
]
},
"docs": "Downloads the log file."
},
{
"info": {
"name": "Creates a log file snapshot.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/logs/:logType",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "logType",
"value": "php-error",
"type": "path",
"description": "An ID that uniquely identifies a log type."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a log file snapshot."
},
{
"info": {
"name": "Returns a logstream url and metadata.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/logstream",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns a logstream url and metadata."
},
{
"info": {
"name": "Disable Live Development on this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/livedev/actions/disable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "discard",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Disable Live Development on this environment."
},
{
"info": {
"name": "Enable Live Development on this environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/livedev/actions/enable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enable Live Development on this environment. Not supported on Acquia Cloud Next."
},
{
"info": {
"name": "Returns a collection of log forwarding destinations for this environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/log-forwarding-destinations",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a collection of log forwarding destinations for this environment.\n\nFilterable fields:\n* `label`\n* `consumer`\n\nSortable fields:\n* `label`\n"
},
{
"info": {
"name": "Creates a log forwarding destination.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/log-forwarding-destinations",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a log forwarding destination."
},
{
"info": {
"name": "Returns the specified log forwarding destination.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/log-forwarding-destinations/:logForwardingDestinationUuid",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "logForwardingDestinationUuid",
"value": "dbd8a966-2b25-11e9-b210-d663bd873d93",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Returns the specified log forwarding destination."
},
{
"info": {
"name": "Updates an environment's log forwarding destination.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/environments/:environmentId/log-forwarding-destinations/:logForwardingDestinationUuid",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "logForwardingDestinationUuid",
"value": "dbd8a966-2b25-11e9-b210-d663bd873d93",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an environment's log forwarding destination."
},
{
"info": {
"name": "Deletes the specified log forwarding destination.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/log-forwarding-destinations/:logForwardingDestinationUuid",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "logForwardingDestinationUuid",
"value": "dbd8a966-2b25-11e9-b210-d663bd873d93",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Deletes the specified log forwarding destination."
},
{
"info": {
"name": "Disables the specified log forwarding destination.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/log-forwarding-destinations/:logForwardingDestinationUuid/actions/disable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "logForwardingDestinationUuid",
"value": "dbd8a966-2b25-11e9-b210-d663bd873d93",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Disables the specified log forwarding destination."
},
{
"info": {
"name": "Enables the specified log forwarding destination.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/log-forwarding-destinations/:logForwardingDestinationUuid/actions/enable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "logForwardingDestinationUuid",
"value": "dbd8a966-2b25-11e9-b210-d663bd873d93",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Enables the specified log forwarding destination."
},
{
"info": {
"name": "Does not return any data. Allows traversal to metrics groups endpoints.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/metrics",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Does not return any data. Allows traversal to metrics groups endpoints."
},
{
"info": {
"name": "Does not return any data. Allows traversal to StackMetrics endpoints.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/metrics/stackmetrics",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Does not return any data. Allows traversal to StackMetrics endpoints."
},
{
"info": {
"name": "Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu).",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/metrics/stackmetrics/data",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n\n**For this endpoint, the \"metric\" filter is required. Multiple metrics can be returned in one request. The following metrics are available:**\n\n* apache-requests, bal-cpu, bal-memory, cron-memory, db-cpu, db-disk-size, db-disk-usage, db-memory, file-disk-size, file-cpu, file-disk-usage, file-memory, http-2xx, http-3xx, http-4xx, http-5xx, mysql-slow-query-count, nginx-requests, out-of-memory, php-proc-max-reached-site, php-proc-max-reached-total, php-proc-site, php-proc-total, varnish-cache-hit-rate, varnish-requests, web-cpu, web-memory\n"
},
{
"name": "from",
"value": "2021-01-29T22:45:21+00:00",
"type": "query",
"description": "An ISO-8601 formatted date retrieve metrics from."
},
{
"name": "to",
"value": "2021-01-29T23:55:21+00:00",
"type": "query",
"description": "An ISO-8601 formatted date retrieve results to."
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns StackMetrics data for the metrics specified by the filter paramater (e.g., apache-access, web-cpu)."
},
{
"info": {
"name": "Retrieves traversal links for an environment's usage data.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/metrics/usage",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves traversal links for an environment's usage data."
},
{
"info": {
"name": "Retrieves usage data for an environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/metrics/usage/data",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `metric` - One of: {`views`, `visits`}\n"
},
{
"info": {
"name": "Retrieves usage metric data for an environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/metrics/usage/:usageMetric",
"params": [
{
"name": "usageMetric",
"value": "views",
"type": "path",
"description": "A usage data metric type."
},
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves usage metric data for an environment."
},
{
"info": {
"name": "Returns the mod proxy status for an Environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/mod-proxy",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the mod proxy status for an Environment."
},
{
"info": {
"name": "Disables mod proxy for an environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/mod-proxy/actions/disable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Disables mod proxy for an environment."
},
{
"info": {
"name": "Enables mod proxy for an environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/mod-proxy/actions/enable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enables mod proxy for an environment."
},
{
"info": {
"name": "Disables production mode for an environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/production-mode/actions/disable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes protection from a production environment, taking it out of production mode."
},
{
"info": {
"name": "Enables production mode for an environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/production-mode/actions/enable",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enables production mode for an environment. While production mode is enabled, files and databases cannot be copied to the production environment."
},
{
"info": {
"name": "Returns a traversal endpoint for search entities for the environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/search",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Does not return any data. Allows traversal to search entity endpoints."
},
{
"info": {
"name": "Returns a collection of search indexes for an environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/search/indexes",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "A collection of search indexes for an environment."
},
{
"info": {
"name": "Creates a search index for an environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/search/indexes",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "config_set_id",
"value": ""
},
{
"name": "database_role",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a search index for an environment."
},
{
"info": {
"name": "Returns a search configuration set for an application",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/search/indexes/:indexId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "indexId",
"value": "ABCDE-1234.test.example",
"type": "path",
"description": "An ID that uniquely identifies an index."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "A specific search configuration set."
},
{
"info": {
"name": "Updates a search index on an environment.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/environments/:environmentId/search/indexes/:indexId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "indexId",
"value": "ABCDE-1234.test.example",
"type": "path",
"description": "An ID that uniquely identifies an index."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "config_set_id",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a search index on an environment."
},
{
"info": {
"name": "Removes and deletes a specific search index from an environment",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/search/indexes/:indexId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "indexId",
"value": "ABCDE-1234.test.example",
"type": "path",
"description": "An ID that uniquely identifies an index."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes and deletes a specific search index from an environment"
},
{
"info": {
"name": "Returns a list of servers.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/servers",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of servers.\n\nFilterable fields:\n* `name`\n* `region`\n* `hostname`\n* `ip`\n* `status`\n\nSortable fields:\n* `name`\n* `region`\n* `hostname`\n* `ip`\n* `status`\n"
},
{
"info": {
"name": "Return details about a specific server.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/servers/:serverId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "serverId",
"value": "42",
"type": "path",
"description": "The internal database identifier of the server."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return details about a specific server."
},
{
"info": {
"name": "Modifies configuration settings for a server.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/environments/:environmentId/servers/:serverId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "serverId",
"value": "42",
"type": "path",
"description": "The internal database identifier of the server."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "memcache",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modifies configuration settings for a server."
},
{
"info": {
"name": "Reboots a server.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/servers/:serverId/actions/reboot",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "serverId",
"value": "42",
"type": "path",
"description": "The internal database identifier of the server."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Reboots a server. This will cause all applications on this server to be unavailable while the server reboots."
},
{
"info": {
"name": "Relaunches a server.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/servers/:serverId/actions/relaunch",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "serverId",
"value": "42",
"type": "path",
"description": "The internal database identifier of the server."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Relaunches a server. This will cause all applications on this server to be unavailable while the server relaunches."
},
{
"info": {
"name": "Suspends a server.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/servers/:serverId/actions/suspend",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "serverId",
"value": "42",
"type": "path",
"description": "The internal database identifier of the server."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Suspends a server. The server will no longer respond to web requests."
},
{
"info": {
"name": "Upgrades a server from \"precise\" to \"xenial\".",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/servers/:serverId/actions/upgrade",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "serverId",
"value": "42",
"type": "path",
"description": "The internal database identifier of the server."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Upgrades a server from \"precise\" to \"xenial\"."
},
{
"info": {
"name": "Provides links to environment settings.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/settings",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Provides links to environment settings."
},
{
"info": {
"name": "Returns the SSL settings for this environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/ssl",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the SSL settings for this environment."
},
{
"info": {
"name": "Return a list of SSL certificates.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/ssl/certificates",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns the SSL certificates that are installed on this environment."
},
{
"info": {
"name": "Install an SSL certificate.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/ssl/certificates",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Install a new SSL certificate on this environment."
},
{
"info": {
"name": "Returns a specific certificate by certificate id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/ssl/certificates/:certificateId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "certificateId",
"value": "7",
"type": "path",
"description": "An ID that uniquely identifies a certificate."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns details about a specific SSL certificate."
},
{
"info": {
"name": "Deletes a specific certificate by its ID.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/ssl/certificates/:certificateId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "certificateId",
"value": "7",
"type": "path",
"description": "An ID that uniquely identifies a certificate."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a specific certificate by its ID."
},
{
"info": {
"name": "Activates an SSL certificate.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/ssl/certificates/:certificateId/actions/activate",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "certificateId",
"value": "7",
"type": "path",
"description": "An ID that uniquely identifies a certificate."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Activates an SSL certificate."
},
{
"info": {
"name": "Deactivates an active SSL certificate.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/ssl/certificates/:certificateId/actions/deactivate",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "certificateId",
"value": "7",
"type": "path",
"description": "An ID that uniquely identifies a certificate."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deactivates an active SSL certificate."
},
{
"info": {
"name": "Returns certificate signing requests.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/ssl/csrs",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns the certificate signing requests for this environment."
},
{
"info": {
"name": "Generates a certificate signing request (CSR) for one or more domains.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/ssl/csrs",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Generates a CSR for one or more domains."
},
{
"info": {
"name": "Returns the certificate signing request for the certificate specified by id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/ssl/csrs/:certificateId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "certificateId",
"value": "7",
"type": "path",
"description": "An ID that uniquely identifies a certificate."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns details about a specific certificate signing request."
},
{
"info": {
"name": "Deletes the certificate signing request.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/ssl/csrs/:certificateId",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "certificateId",
"value": "7",
"type": "path",
"description": "An ID that uniquely identifies a certificate."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the certificate signing request for the certificate specified by id."
},
{
"info": {
"name": "Returns a list of environment variables associated with this environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/variables",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of environment variables associated with this environment.\n\nFilterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Adds a new environment variable to an environment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/environments/:environmentId/variables",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
},
{
"name": "value",
"value": ""
}
]
}
},
"docs": "Adds a new environment variable to an environment."
},
{
"info": {
"name": "Get an environment variable associated with this environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/variables/:environmentVariableName",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "environmentVariableName",
"value": "EXAMPLE_VARIABLE_NAME",
"type": "path",
"description": "The environment variable name."
}
]
},
"docs": "Get an environment variable associated with this environment."
},
{
"info": {
"name": "Updates an environment variable on an environment.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/environments/:environmentId/variables/:environmentVariableName",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "environmentVariableName",
"value": "EXAMPLE_VARIABLE_NAME",
"type": "path",
"description": "The environment variable name."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
},
{
"name": "value",
"value": ""
}
]
}
},
"docs": "Updates an environment variable on an environment."
},
{
"info": {
"name": "Removes an environment variable from an environment.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/environments/:environmentId/variables/:environmentVariableName",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
},
{
"name": "environmentVariableName",
"value": "EXAMPLE_VARIABLE_NAME",
"type": "path",
"description": "The environment variable name."
}
]
},
"docs": "Removes an environment variable from an environment."
}
]
},
{
"info": {
"name": "Email",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns the status of Platform Email for an Environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/email",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the status of Platform Email for an Environment."
}
]
},
{
"info": {
"name": "Application Performance Monitoring Services",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns a list of Application Performance Monitoring services associated with the environment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/environments/:environmentId/settings/apm",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
]
},
"docs": "Returns a list of Application Performance Monitoring services associated with the environment."
},
{
"info": {
"name": "Update configuration for an Application Performance Monitoring tool.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/environments/:environmentId/settings/apm",
"params": [
{
"name": "environmentId",
"value": "12-d314739e-296f-11e9-b210-d663bd873d93",
"type": "path",
"description": "The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "status",
"value": ""
},
{
"name": "type",
"value": ""
},
{
"name": "key",
"value": ""
}
]
}
},
"docs": "Update configuration for an Application Performance Monitoring tool."
},
{
"info": {
"name": "Returns a list of Application Performance Monitoring services associated with the subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/apm",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
]
},
"docs": "Returns a list of Application Performance Monitoring services associated with the subscription."
},
{
"info": {
"name": "Returns the Application Performance Monitoring service type associated with the subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/apm/:apmType",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "apmType",
"value": "newrelic",
"type": "path",
"description": "The APM type."
}
]
},
"docs": "Returns the Application Performance Monitoring service type associated with the subscription."
},
{
"info": {
"name": "Enables New Relic Pro APM license for all applications on a subscription.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/apm/:apmType/actions/opt-in",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "apmType",
"value": "newrelic",
"type": "path",
"description": "The APM type."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enables New Relic Pro APM license for all applications on a subscription. This authorizes Acquia to create a new user account on the third-party New Relic platform using the name and e-mail address of the organization owner."
}
]
},
{
"info": {
"name": "Cloud IDE",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns Cloud IDE info.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/ides/:ideUuid",
"params": [
{
"name": "ideUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The Cloud IDE universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns Cloud IDE info."
},
{
"info": {
"name": "De-provisions a specific Cloud IDE.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/ides/:ideUuid",
"params": [
{
"name": "ideUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The Cloud IDE universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "De-provisions a specific Cloud IDE."
}
]
},
{
"info": {
"name": "Identity Providers",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns a list of identity providers for a user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity-providers",
"params": [
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of identity providers you have access to.\n\nFilterable fields:\n* `label`\n\nSortable fields:\n* `label`\n"
},
{
"info": {
"name": "Returns a specific identity provider by UUID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity-providers/:identityProviderUuid",
"params": [
{
"name": "identityProviderUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a specific identity provider."
},
{
"info": {
"name": "Modifies an identity provider by its UUID.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/identity-providers/:identityProviderUuid",
"params": [
{
"name": "identityProviderUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "label",
"value": ""
},
{
"name": "entity_id",
"value": ""
},
{
"name": "sso_url",
"value": ""
},
{
"name": "certificate",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modifies an identity provider."
},
{
"info": {
"name": "Deletes a specific identity provider by its UUID.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/identity-providers/:identityProviderUuid",
"params": [
{
"name": "identityProviderUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a specific identity provider."
},
{
"info": {
"name": "Enables an identity provider by its UUID.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity-providers/:identityProviderUuid/actions/enable",
"params": [
{
"name": "identityProviderUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enables an identity provider."
},
{
"info": {
"name": "Disables an identity provider by its UUID.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity-providers/:identityProviderUuid/actions/disable",
"params": [
{
"name": "identityProviderUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Disables an identity provider."
}
]
},
{
"info": {
"name": "Invite",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns details about an invitation.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/invites/:token",
"params": [
{
"name": "token",
"value": "",
"type": "path",
"description": "The token identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns details about an invitation."
},
{
"info": {
"name": "Cancels an invitation.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/invites/:token",
"params": [
{
"name": "token",
"value": "",
"type": "path",
"description": "The token identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Cancels an invitation."
},
{
"info": {
"name": "Accepts an invite.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/invites/:token/actions/accept",
"params": [
{
"name": "token",
"value": "",
"type": "path",
"description": "The token identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Accepts an invite."
},
{
"info": {
"name": "Declines an invite.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/invites/:token/actions/decline",
"params": [
{
"name": "token",
"value": "",
"type": "path",
"description": "The token identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Declines an invite."
},
{
"info": {
"name": "Resend an invite.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/invites/:token/actions/resend",
"params": [
{
"name": "token",
"value": "",
"type": "path",
"description": "The token identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Resend an invite."
}
]
},
{
"info": {
"name": "Messages",
"type": "folder"
},
"items": [
{
"info": {
"name": "Dismisses a message.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/messages/:messageUuid/actions/dismiss",
"params": [
{
"name": "messageUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Dismisses a message."
},
{
"info": {
"name": "Follows an in-product message link.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/messages/:messageUuid/actions/follow",
"params": [
{
"name": "messageUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
]
},
"docs": "Follows an in-product message link."
}
]
},
{
"info": {
"name": "Notifications",
"type": "folder"
},
"items": [
{
"info": {
"name": "Returns a single notification.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/notifications/:notificationUuid",
"params": [
{
"name": "notificationUuid",
"value": "2343b683-b194-4217-982a-6a95c72ad9a8",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a single notification."
}
]
},
{
"info": {
"name": "Options",
"type": "folder"
},
"items": [
{
"info": {
"name": "Does not return any data. Allows traversal of options groups endpoints.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/options"
},
"docs": "Does not return any data. Allows traversal of options groups endpoints."
},
{
"info": {
"name": "Displays the various CD Environment size options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/options/cde-sizes"
},
"docs": "Displays the various CD Environment size options."
},
{
"info": {
"name": "Does not return any data. Allows traversal of options groups endpoints.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/options/log-forwarding"
},
"docs": "Does not return any data. Allows traversal of options groups endpoints."
},
{
"info": {
"name": "Displays available log forwarding sources.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/options/log-forwarding/sources"
},
"docs": "Displays available log forwarding sources."
},
{
"info": {
"name": "Displays available log forwarding consumers.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/options/log-forwarding/consumers"
},
"docs": "Displays available log forwarding consumers."
},
{
"info": {
"name": "Displays the various color options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/options/colors"
},
"docs": "Displays the various color options."
}
]
},
{
"info": {
"name": "Organizations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return a list of organizations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations"
},
"docs": "An organization is a container for some or all of a customer's subscriptions. The owner of the organization is the\nmain billing contact. The owner, along with organization administrators, can set up teams and roles to grant various\npermissions to access the applications within each subscription in the organization. Results can be filtered and\nsorted by name.\n"
},
{
"info": {
"name": "Return details about a specific organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "A specific organization."
},
{
"info": {
"name": "Renames an organization.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/organizations/:organizationUuid",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Renames an organization."
},
{
"info": {
"name": "Deletes a specific organization by its UUID.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organizations/:organizationUuid",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a specific organization."
},
{
"info": {
"name": "Changes the organization owner.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organizations/:organizationUuid/actions/change-owner",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "user_uuid",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Changes the organization owner."
},
{
"info": {
"name": "Removes your account from an organization.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organizations/:organizationUuid/actions/leave",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes your account from an organization."
},
{
"info": {
"name": "Returns a list of organization administrators.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/admins",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of organization administrators.\n\nFilterable fields:\n* `first_name`\n* `last_name`\n* `mail`\n* `username`\n\nSortable fields:\n* `first_name`\n* `last_name`\n* `mail`\n* `username`\n"
},
{
"info": {
"name": "Returns the user profile of this organization administrator.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/admins/:userUuid",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the user profile of this organization administrator."
},
{
"info": {
"name": "Removes the user from the list of administrators for the organization.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organizations/:organizationUuid/admins/:userUuid",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the user from the list of administrators for the organization."
},
{
"info": {
"name": "Gets a list of invitations of administrators for this organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/admin-invites",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
},
{
"name": "range",
"value": "",
"type": "query",
"description": "ISO-8601 date/time of invite create date/time."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a list of invitations of administrators for this organization.\n\nFilterable fields:\n* `first_name`\n* `last_name`\n* `permission`\n\nSortable fields:\n* `first_name`\n* `last_name`\n* `permission`\n"
},
{
"info": {
"name": "Invites a user to be an administrator in this organization.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organizations/:organizationUuid/admin-invites",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "email",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Invites a user to be an administrator in this organization."
},
{
"info": {
"name": "Returns a list of applications that belong to the organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/applications",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of applications that belong to the organization.\n\nFilterable fields:\n* `name`\n* `organization_name`\n\nSortable fields:\n* `name`\n* `organization_name`\n"
},
{
"info": {
"name": "Returns a list of all available application tags.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/available-tags",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of all available application tags."
},
{
"info": {
"name": "Adds bulk tags to organization resources.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organizations/:organizationUuid/available-tags",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "tags",
"value": ""
},
{
"name": "context",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds bulk tags to organization resources."
},
{
"info": {
"name": "Deletes bulk tags from organization resources.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organizations/:organizationUuid/available-tags",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "tags",
"value": ""
},
{
"name": "context",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes bulk tags from organization resources."
},
{
"info": {
"name": "Returns an identity provider for an organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/identity-provider",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns an identity provider for an organization."
},
{
"info": {
"name": "Returns a list of all organization members.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/members",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of all organization members, from all teams in this organization.\n\nFilterable fields:\n* `first_name`\n* `last_name`\n* `permission`\n\nSortable fields:\n* `first_name`\n* `last_name`\n* `permission`\n"
},
{
"info": {
"name": "Returns the user profile of this organization member.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/members/:userUuid",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the user profile of this organization member."
},
{
"info": {
"name": "Removes the member from the organization.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/organizations/:organizationUuid/members/:userUuid",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the member from the organization."
},
{
"info": {
"name": "Returns a list of applications that an organization member has access to.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/members/:userUuid/applications",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of applications that an organization member has access to."
},
{
"info": {
"name": "Returns a list of notifications associated with this organization by its UUID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/notifications",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of notifications associated with this organization. A notification represents an item of work to be done, initiated by someone (typically the current user) associated with the organization.\n\nFilterable fields:\n* `event`\n* `label`\n* `description`\n* `status`\n* `author`\n* `created_at`\n* `completed_at`\n\nSortable fields:\n* `event`\n* `label`\n* `description`\n* `status`\n* `author`\n* `created_at`\n* `completed_at`\n"
},
{
"info": {
"name": "Returns a list of all the canonical roles within the organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/roles",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
},
{
"name": "range",
"value": "",
"type": "query",
"description": "ISO-8601 date/time of invite create date/time."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of all the canonical roles within the organization.\n\nFilterable fields:\n* `name`\n* `edited_at'\n\nSortable fields:\n* `name`\n* `edited_at`\n"
},
{
"info": {
"name": "Creates a role.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organizations/:organizationUuid/roles",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
},
{
"name": "description",
"value": ""
},
{
"name": "permissions",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a role."
},
{
"info": {
"name": "Returns a list of subscriptions that belong to the organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/subscriptions",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
},
{
"name": "range",
"value": "",
"type": "query",
"description": "ISO-8601 date/time of invite create date/time."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of subscriptions that belong to the organization.\n\nFilterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Gets a list of member invitations for all teams in this organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/team-invites",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a list of member invitations for all teams in this organization.\n\nFilterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Returns a list of teams associated with the organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/organizations/:organizationUuid/teams",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of teams associated with the organization.\n\nFilterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Creates a team.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/organizations/:organizationUuid/teams",
"params": [
{
"name": "organizationUuid",
"value": "1e7efab9-0fac-4a2c-ad94-61efc78623ba",
"type": "path",
"description": "The organization entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a team."
}
]
},
{
"info": {
"name": "Teams and Permissions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return a list of permissions.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/permissions"
},
"docs": "Displays a list of all available permissions currently in the system. This will include permissions that the user\nmay not have access to.\n"
},
{
"info": {
"name": "Return details about a specific role.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/roles/:roleUuid",
"params": [
{
"name": "roleUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Roles may be assigned to team members, and grant various permissions to the applications that the team is assigned\nto. Roles are unique within a organization.\n"
},
{
"info": {
"name": "Updates a role.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/roles/:roleUuid",
"params": [
{
"name": "roleUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
},
{
"name": "description",
"value": ""
},
{
"name": "permissions",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modifies a role."
},
{
"info": {
"name": "Deletes a specific role by its UUID.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/roles/:roleUuid",
"params": [
{
"name": "roleUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a specific role."
},
{
"info": {
"name": "Return teams the current user has access to.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/teams",
"params": [
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
},
{
"name": "range",
"value": "",
"type": "query",
"description": "ISO-8601 date/time of invite create date/time."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns a list of teams the current user has access to.\n\nFilterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Return details about a specific team.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/teams/:teamUuid",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return details about a specific team."
},
{
"info": {
"name": "Change the name of a team.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/teams/:teamUuid",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Change the name of a team."
},
{
"info": {
"name": "Deletes a specific team by its UUID.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/teams/:teamUuid",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a specific team by its UUID."
},
{
"info": {
"name": "Removes the current user from a team.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/teams/:teamUuid/actions/leave",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the current user from a team."
},
{
"info": {
"name": "Returns a list of applications this team has access to.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/teams/:teamUuid/applications",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of applications this team has access to.\n\nFilterable fields:\n* `name`\n\nSortable fields:\n* `name`\n"
},
{
"info": {
"name": "Adds an application to this team.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/teams/:teamUuid/applications",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "uuid",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds an application to this team."
},
{
"info": {
"name": "Removes the application from this team.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/teams/:teamUuid/applications/:applicationUuid",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "applicationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes the application from this team. Team members will immediately lose access to this application."
},
{
"info": {
"name": "Returns a list of invitations to this team.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/teams/:teamUuid/invites",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
},
{
"name": "range",
"value": "",
"type": "query",
"description": "ISO-8601 date/time of invite create date/time."
}
]
},
"docs": "Returns a list of invitations to this team.\n\nFilterable fields:\n* `mail`\n* `token`\n* `author`\n\nSortable fields:\n* `mail`\n* `token`\n* `author`\n"
},
{
"info": {
"name": "Invites a user to join a team.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/teams/:teamUuid/invites",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": []
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Invites a user to join a team."
},
{
"info": {
"name": "Returns a list of team members.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/teams/:teamUuid/members",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of team members.\n\nFilterable fields:\n* `permission`\n* `first_name`\n* `last_name`\n* `user`\n\nSortable fields:\n* `permission`\n* `first_name`\n* `last_name`\n"
},
{
"info": {
"name": "Grant team roles to a member.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/teams/:teamUuid/members/:userUuid",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "roles",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Grant team roles to a member."
},
{
"info": {
"name": "Remove a user from a team.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/teams/:teamUuid/members/:userUuid",
"params": [
{
"name": "teamUuid",
"value": "3eef5d81-62f4-429c-aa94-e17d05ab4740",
"type": "path",
"description": "The entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Remove a user from a team."
}
]
},
{
"info": {
"name": "Subscriptions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Return a list of subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions",
"params": [
{
"name": "from",
"value": "2023-09-01",
"type": "query",
"description": "Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n"
},
{
"name": "to",
"value": "2023-09-29",
"type": "query",
"description": "Optionally specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nSome examples:\n* `2023-09-29`\n* `2023-09-29T00%3A00%3A00.000Z` (`2023-09-29T00:00:00.000Z`)\n"
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Filterable fields:\n* `from`\n* `to`\n* `sort`\n* `filter`\n* `limit`\n* `offset`\n\nSortable fields:\n* `from`\n* `to`\n* `sort`\n* `filter`\n* `limit`\n* `offset`\n"
},
{
"info": {
"name": "Return details about a specific subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return details about a specific subscription."
},
{
"info": {
"name": "Modifies a subscription.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "name",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Modifies a subscription."
},
{
"info": {
"name": "Provides a list of applications that are a part of the subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/applications",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Filterable fields:\n* `from`\n* `to`\n* `sort`\n* `filter`\n* `limit`\n* `offset`\n\nSortable fields:\n* `from`\n* `to`\n* `sort`\n* `filter`\n* `limit`\n* `offset`\n"
},
{
"info": {
"name": "Retrieves Code Studio metadata for a subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/code-studio",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves Code Studio metadata for a subscription."
},
{
"info": {
"name": "Displays Code Studio options for a subscription.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/code-studio",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Displays Code Studio options for a subscription."
},
{
"info": {
"name": "Enables Code Studio for a subscription.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/code-studio/actions/enable",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Enables and provisions Code Studio at the subscription level."
},
{
"info": {
"name": "Retrieves a list of Code Studio enabled applications for a subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/code-studio/applications",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves a list of Code Studio enabled applications for a subscription."
},
{
"info": {
"name": "Retrieves a list of users assigned to Code Studio for a subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/code-studio/users",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves a list of users assigned to Code Studio for a subscription."
},
{
"info": {
"name": "Assigns a user to a Code Studio seat for a subscription.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/code-studio/users",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assigns a user to Code Studio seat for a subscription."
},
{
"info": {
"name": "Retrieves details about a specific Code Studio user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/code-studio/users/:userUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves details about a specific Code Studio user."
},
{
"info": {
"name": "Unassigns a user from a Code Studio seat.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/code-studio/users/:userUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "userUuid",
"value": "f2daa9cc-e5a0-4036-a5c8-f96e336c62b5",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Unassigns a user from a Code Studio seat."
},
{
"info": {
"name": "Returns a list of Domains registered with this subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/domains",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "sort",
"value": "field1,-field2",
"type": "query",
"description": "A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nThere are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:\n\n* Equals: `= (%3D)`\n* Does not equal: `!= (!%3D)`\n* Greater than: `> (%3E)`\n* Less than: `< (%3C)`\n* Greater than or equal to: `>= (%3E%3D)`\n* Less than or equal to: `<= (%3C%3D)`\n* Contains substring: `=@ (%3D@)`\n* Does not contain substring: `!@ (!@)`\n\nFilters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`).\n\nSome examples:\n* `filter=field%3Dvalue` (`field` equals `'value'`)\n* `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`)\n* `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)\n"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Returns a list of Domains registered with this subscription."
},
{
"info": {
"name": "Registers a Domain with this subscription.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/domains",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "domain",
"value": ""
}
]
}
},
"docs": "Registers a Domain with this subscription."
},
{
"info": {
"name": "Returns a speicific Domain registered with this subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/domains/:domainRegistrationUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "domainRegistrationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The Domain Registration universally unique identifier."
}
]
},
"docs": "Returns a speicific Domain registered with this subscription."
},
{
"info": {
"name": "Unregisters a Domain registered with this subscription.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/domains/:domainRegistrationUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "domainRegistrationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The Domain Registration universally unique identifier."
}
]
},
"docs": "Unregisters a Domain registered with this subscription."
},
{
"info": {
"name": "Triggers re-verification and update to the domain verification status.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/domains/:domainRegistrationUuid/actions/verify",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "domainRegistrationUuid",
"value": "da1c0a8e-ff69-45db-88fc-acd6d2affbb7",
"type": "path",
"description": "The Domain Registration universally unique identifier."
}
]
},
"docs": "Triggers re-verification and update to the domain verification status."
},
{
"info": {
"name": "Provides a list of entitlements that are a part of the subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/entitlements",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
]
},
"docs": "Provides a list of entitlements that are a part of the subscription."
},
{
"info": {
"name": "Returns a list of Cloud IDEs associated with this subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/ides",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
]
},
"docs": "Returns a list of Cloud IDEs associated with this subscription."
},
{
"info": {
"name": "Retrieves traversal links for a subscription's usage data.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/metrics/usage",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves traversal links for a subscription's usage data."
},
{
"info": {
"name": "Retrieves aggregate usage data for a subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/metrics/usage/data",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `metric` - One of: {`views`, `visits`}\n* `application`\n* `from`\n* `to`\n"
},
{
"info": {
"name": "Retrieves usage data for a subscription, broken down by application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/metrics/usage/data-by-application",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `metric` - One of: {`views`, `visits`}\n* `application`\n"
},
{
"info": {
"name": "Retrieves aggregate usage metric data for a subscription.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/metrics/usage/:usageMetric",
"params": [
{
"name": "usageMetric",
"value": "views",
"type": "path",
"description": "A usage data metric type."
},
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `application`\n"
},
{
"info": {
"name": "Retrieves views data for a subscription, broken down by application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/metrics/usage/views-by-application",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `application`\n"
},
{
"info": {
"name": "Retrieves visits data for a subscription, broken down by application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/metrics/usage/visits-by-application",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.\n\nFilter parameters include:\n* `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format.\n* `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format.\n\nFormatting examples:\n* `2023-09-01`\n* `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`)\n\nUsage examples:\n* `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`)\n* `{endpoint}?filter=from%3D2025-04-01T00:00:00.000Z,to%3D2025-04-30T23:59:59.000Z` (`from` is `2025-04-01T00:00:00.000Z` and `to` is `2025-04-30T23:59:59.000Z`)\n"
},
{
"name": "resolution",
"value": "",
"type": "query",
"description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Filterable fields:\n* `application`\n"
},
{
"info": {
"name": "Provides a list of Shield ACL rules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/shield-acl",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "The maximum number of items to return."
},
{
"name": "offset",
"value": "10",
"type": "query",
"description": "An integer to signify the offset to paginate from."
}
]
},
"docs": "Provides a list of Shield ACL rules."
},
{
"info": {
"name": "Creates a Shield ACL rule.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/shield-acl",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "description",
"value": ""
},
{
"name": "addresses",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a Shield ACL rule."
},
{
"info": {
"name": "Returns the specified Shield ACL rule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/shield-acl/:shieldAclUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "shieldAclUuid",
"value": "a1234567-1234-123a-abc1-12ab345cd678",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Returns the specified Shield access control list (ACL) rule for a subscription."
},
{
"info": {
"name": "Updates a Shield ACL rule.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/shield-acl/:shieldAclUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "shieldAclUuid",
"value": "a1234567-1234-123a-abc1-12ab345cd678",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"body": {
"type": "form-urlencoded",
"data": [
{
"name": "description",
"value": ""
},
{
"name": "addresses",
"value": ""
}
]
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a Shield ACL rule."
},
{
"info": {
"name": "Deletes a Shield ACL rule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/shield-acl/:shieldAclUuid",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
},
{
"name": "shieldAclUuid",
"value": "a1234567-1234-123a-abc1-12ab345cd678",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://accounts.acquia.com/api/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a Shield ACL rule."
},
{
"info": {
"name": "Resets Shield ACL rules to default settings.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/subscriptions/:subscriptionUuid/shield-acl/actions/reset",
"params": [
{
"name": "subscriptionUuid",
"value": "0f3ad33e-2fe4-11e9-b210-d663bd873d93",
"type": "path",
"description": "The subscription entity's universally unique identifier."
}
]
},
"docs": "Resets the Shield ACL rules for a subscription to the default settings. This action is irreversible and will remove all custom rules.\n\nThis operation can only be performed on subscriptions that have Acquia Shield enabled. If there are ongoing updates to the Shield ACL rules, this operation will fail with a conflict error.\n"
}
]
},
{
"info": {
"name": "Codebases",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieves a list of bulk code switches details performed on a codebase.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/codebases/:codebaseId/bulk-code-switch",
"params": [
{
"name": "codebaseId",
"value": "",
"type": "path"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The collection page number"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The number of items per page"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieves a list of bulk code switches details performed on a codebase."
},
{
"info": {
"name": "Starts a new Bulk Code Switch for a codebase.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/codebases/:codebaseId/bulk-code-switch",
"params": [
{
"name": "codebaseId",
"value": "",
"type": "path",
"description": "The codebase entity's unique identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Starts a new Bulk Code Switch for a codebase."
},
{
"info": {
"name": "Retrieves bulk code switch details by id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/codebases/:codebaseId/bulk-code-switch/:bulkCodeSwitchId",
"params": [
{
"name": "codebaseId",
"value": "",
"type": "path",
"description": "The codebase entity's unique identifier."
},
{
"name": "bulkCodeSwitchId",
"value": "",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieves bulk code switch details by id."
},
{
"info": {
"name": "Retrieves a codebase details linked to the specified application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/applications/:applicationId/codebase",
"params": [
{
"name": "applicationId",
"value": "",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieves a codebase details linked to the specified application."
},
{
"info": {
"name": "Retrieves a list of codebases accessible by the user.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/codebases",
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieves a list of codebases accessible by the user."
},
{
"info": {
"name": "Retrieves a codebase details by its ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/codebases/:codebaseId",
"params": [
{
"name": "codebaseId",
"value": "",
"type": "path",
"description": "The codebase entity's unique identifier."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Return details about a specific codebase."
},
{
"info": {
"name": "Update a codebase details by its ID.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/codebases/:codebaseId",
"params": [
{
"name": "codebaseId",
"value": "",
"type": "path",
"description": "The codebase entity's unique identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Update a codebase details by its ID."
},
{
"info": {
"name": "Delete a codebase by its ID.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/codebases/:codebaseId",
"params": [
{
"name": "codebaseId",
"value": "",
"type": "path",
"description": "The codebase entity's unique identifier."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Delete a codebase by its ID."
},
{
"info": {
"name": "Retrieves a list of codebases by subscription ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionId/codebases",
"params": [
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieves a list of codebases by subscription ID."
},
{
"info": {
"name": "Gets supported regions for a new codebase.",
"type": "http"
},
"http": {
"method": "OPTIONS",
"url": "{{baseUrl}}/subscriptions/:subscriptionId/codebases",
"params": [
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "The entity's universally unique identifier."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Gets supported regions for a new codebase."
},
{
"info": {
"name": "Retrieves a list of git references by codebase.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/codebases/:codebaseId/references",
"params": [
{
"name": "codebaseId",
"value": "",
"type": "path",
"description": "The codebase entity's unique identifier."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieves a list of git references by codebase."
},
{
"info": {
"name": "Retrieves a single git reference data for the given codebase.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/codebases/:codebaseId/references/:referenceName",
"params": [
{
"name": "codebaseId",
"value": "",
"type": "path",
"description": "The codebase entity's unique identifier."
},
{
"name": "referenceName",
"value": "",
"type": "path",
"description": "The reference name."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Retrieves a single git reference data for the given codebase."
}
]
},
{
"info": {
"name": "Private Networks",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a new Private Network",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/private-networks",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new Private Network with optional subresource configuration.\n\nThis comprehensive endpoint allows you to create a private network and optionally configure \nits subresources (connections, VPNs, VPC peers, ingress, and isolation) during the initial creation.\n\n**Subresource Creation:**\n- **Connections**: Configure CIDR block and egress access settings\n- **VPNs**: Create one or more VPN connections with tunnel configurations\n- **VPC Peers**: Create one or more VPC peering connections\n- **In"
},
{
"info": {
"name": "Retrieve a Private Network by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/private-networks/:privateNetworkId",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
]
},
"docs": "Retrieves a Private Network by its ID."
},
{
"info": {
"name": "Update a Private Network",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/private-networks/:privateNetworkId",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing Private Network by its ID. Does not allow creation of new Private Networks."
},
{
"info": {
"name": "Delete a Private Network",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/private-networks/:privateNetworkId",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
]
},
"docs": "Deletes a Private Network by its ID."
},
{
"info": {
"name": "List Private Networks for a Subscription",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionId/private-networks",
"params": [
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "ID of the subscription"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The number of items to skip before starting to collect the result set."
},
{
"name": "sort",
"value": "name,-created_at",
"type": "query",
"description": "Sort the result set by one or more fields.\n\n**Format:** `field1,field2,-field3`\n\n**Sort order:**\n- No prefix - Ascending order (default)\n- `-` prefix - Descending order\n\n**Multiple fields:**\n- Fields are processed in the order specified\n- First field has highest priority\n- Use comma to separate multiple fields\n\n**Examples:**\n- `name` - Sort by name in ascending order\n- `-created_at` - Sort by created_at in descending order\n- `name,-created_at` - Sort by name ascending, then created_at descending\n- `status,name,-updated_at` - Sort by status ascending, then name ascending, then updated_at descending\n"
},
{
"name": "filter",
"value": "status:active;type:standard",
"type": "query",
"description": "Filter the result set using field-based criteria.\n\n**Format:** `field:value`, `field=value` or `field:operator:value`\n\n**Logical operators:**\n- `,` (comma) - OR logic between filters\n- `;` (semicolon) - AND logic between filters\n- **Note:** Cannot mix OR and AND operators in the same query\n\n**Comparison operators:**\n- `=` - Equals (default if no operator specified)\n- `!=` - Does not equal\n- `>` - Greater than\n- `<` - Less than\n- `>=` - Greater than or equal to\n- `<=` - Less than or equal to\n- `=@` - Contains substring\n- `!@` - Does not contain substring\n\n**Wildcards:**\n- `*` - Wildcard character for pattern matching\n\n**Examples:**\n- `status=active` - Filter by status equals active\n- `name=@prod` - Filter by name containing \"prod\"\n- `status=active;type=standard` - Status is active AND type is standard\n- `status=active,status=pending` - Status is active OR pending\n"
}
]
},
"docs": "Retrieves a paginated list of Private Networks for a given subscription."
},
{
"info": {
"name": "Get VPNs for a Private Network",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpns",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The number of items to skip before starting to collect the result set."
},
{
"name": "sort",
"value": "name,-created_at",
"type": "query",
"description": "Sort the result set by one or more fields.\n\n**Format:** `field1,field2,-field3`\n\n**Sort order:**\n- No prefix - Ascending order (default)\n- `-` prefix - Descending order\n\n**Multiple fields:**\n- Fields are processed in the order specified\n- First field has highest priority\n- Use comma to separate multiple fields\n\n**Examples:**\n- `name` - Sort by name in ascending order\n- `-created_at` - Sort by created_at in descending order\n- `name,-created_at` - Sort by name ascending, then created_at descending\n- `status,name,-updated_at` - Sort by status ascending, then name ascending, then updated_at descending\n"
},
{
"name": "filter",
"value": "status:active;type:standard",
"type": "query",
"description": "Filter the result set using field-based criteria.\n\n**Format:** `field:value`, `field=value` or `field:operator:value`\n\n**Logical operators:**\n- `,` (comma) - OR logic between filters\n- `;` (semicolon) - AND logic between filters\n- **Note:** Cannot mix OR and AND operators in the same query\n\n**Comparison operators:**\n- `=` - Equals (default if no operator specified)\n- `!=` - Does not equal\n- `>` - Greater than\n- `<` - Less than\n- `>=` - Greater than or equal to\n- `<=` - Less than or equal to\n- `=@` - Contains substring\n- `!@` - Does not contain substring\n\n**Wildcards:**\n- `*` - Wildcard character for pattern matching\n\n**Examples:**\n- `status=active` - Filter by status equals active\n- `name=@prod` - Filter by name containing \"prod\"\n- `status=active;type=standard` - Status is active AND type is standard\n- `status=active,status=pending` - Status is active OR pending\n"
}
]
},
"docs": "Retrieves the VPN Connections for a Private Network."
},
{
"info": {
"name": "Add a new VPN to an existing private network",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpns",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a new VPN to the connections block of an existing private network"
},
{
"info": {
"name": "Retrieve a VPN for a Private Network.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpns/:vpnId",
"params": [
{
"name": "vpnId",
"value": "",
"type": "path",
"description": "ID of the VPN"
},
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
]
},
"docs": "Retrieves a VPN for a Private Network by Private Network ID and VPN ID."
},
{
"info": {
"name": "Create or update a VPN for a Private Network.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpns/:vpnId",
"params": [
{
"name": "vpnId",
"value": "",
"type": "path",
"description": "ID of the VPN"
},
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new VPN or updates an existing VPN for a Private Network by Private Network ID and VPN ID."
},
{
"info": {
"name": "Delete a VPN for a Private Network.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpns/:vpnId",
"params": [
{
"name": "vpnId",
"value": "",
"type": "path",
"description": "ID of the VPN"
},
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
]
},
"docs": "Deletes a VPN for a Private Network by Private Network ID and VPN ID."
},
{
"info": {
"name": "Get VPC Peers for a Private Network",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpc-peers",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The number of items to skip before starting to collect the result set."
},
{
"name": "sort",
"value": "name,-created_at",
"type": "query",
"description": "Sort the result set by one or more fields.\n\n**Format:** `field1,field2,-field3`\n\n**Sort order:**\n- No prefix - Ascending order (default)\n- `-` prefix - Descending order\n\n**Multiple fields:**\n- Fields are processed in the order specified\n- First field has highest priority\n- Use comma to separate multiple fields\n\n**Examples:**\n- `name` - Sort by name in ascending order\n- `-created_at` - Sort by created_at in descending order\n- `name,-created_at` - Sort by name ascending, then created_at descending\n- `status,name,-updated_at` - Sort by status ascending, then name ascending, then updated_at descending\n"
},
{
"name": "filter",
"value": "status:active;type:standard",
"type": "query",
"description": "Filter the result set using field-based criteria.\n\n**Format:** `field:value`, `field=value` or `field:operator:value`\n\n**Logical operators:**\n- `,` (comma) - OR logic between filters\n- `;` (semicolon) - AND logic between filters\n- **Note:** Cannot mix OR and AND operators in the same query\n\n**Comparison operators:**\n- `=` - Equals (default if no operator specified)\n- `!=` - Does not equal\n- `>` - Greater than\n- `<` - Less than\n- `>=` - Greater than or equal to\n- `<=` - Less than or equal to\n- `=@` - Contains substring\n- `!@` - Does not contain substring\n\n**Wildcards:**\n- `*` - Wildcard character for pattern matching\n\n**Examples:**\n- `status=active` - Filter by status equals active\n- `name=@prod` - Filter by name containing \"prod\"\n- `status=active;type=standard` - Status is active AND type is standard\n- `status=active,status=pending` - Status is active OR pending\n"
}
]
},
"docs": "Retrieves the VPC Peers for a Private Network."
},
{
"info": {
"name": "Add a new VPC Peer to an existing private network",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpc-peers",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a new VPC Peer to the connections block of an existing private network"
},
{
"info": {
"name": "Get a specific VPC Peer from a private network",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpc-peers/:vpcPeerId",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
},
{
"name": "vpcPeerId",
"value": "",
"type": "path",
"description": "ID of the VPC Peer"
}
]
},
"docs": "Retrieves details of a specific VPC Peer from a private network"
},
{
"info": {
"name": "Delete a VPC Peer for a Private Network.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections/vpc-peers/:vpcPeerId",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
},
{
"name": "vpcPeerId",
"value": "",
"type": "path",
"description": "ID of the VPC Peer"
}
]
},
"docs": "Deletes a VPC Peer for a Private Network by Private Network ID and VPC Peer name."
},
{
"info": {
"name": "Get Connections for a Private Network.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
]
},
"docs": "Retrieves the Connections block for a Private Network, including VPNs and VPC Peers."
},
{
"info": {
"name": "Update Connections for a Private Network.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/connections",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the Connections configuration for a Private Network by Private Network ID."
},
{
"info": {
"name": "Get Isolation for a Private Network.",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/isolation",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
]
},
"docs": "Retrieves the Isolation configuration for a Private Network."
},
{
"info": {
"name": "Update isolation settings of a private network",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/isolation",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the isolation settings of a private network"
},
{
"info": {
"name": "Get Ingress for a Private Network",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/ingress",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
]
},
"docs": "Retrieves the Ingress configuration for a Private Network."
},
{
"info": {
"name": "Update Ingress for a Private Network.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/private-networks/:privateNetworkId/ingress",
"params": [
{
"name": "privateNetworkId",
"value": "",
"type": "path",
"description": "ID of the private network"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the Ingress configuration for a Private Network by Private Network ID. Ingress always exists for a Private Network."
}
]
}
],
"bundled": true
}