components: examples: {} headers: {} parameters: Acquia_Cloud_API_Documentation_AgreementUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_agreement-uuid' Acquia_Cloud_API_Documentation_AlertUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_alert-uuid' Acquia_Cloud_API_Documentation_ApmType: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_apm-type' Acquia_Cloud_API_Documentation_ApplicationUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid' Acquia_Cloud_API_Documentation_ArtifactId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_artifact-id' Acquia_Cloud_API_Documentation_BackupId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_backup-id' Acquia_Cloud_API_Documentation_CertificateId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_certificate-id' Acquia_Cloud_API_Documentation_ConfigurationSetId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_configuration-set-id' Acquia_Cloud_API_Documentation_CronId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_cron-id' Acquia_Cloud_API_Documentation_DatabaseName: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_database-name' Acquia_Cloud_API_Documentation_DeprecatedFrom: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_deprecated-from' Acquia_Cloud_API_Documentation_DeprecatedTo: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_deprecated-to' Acquia_Cloud_API_Documentation_Domain: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain' Acquia_Cloud_API_Documentation_DomainRegistrationUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_domain-registration-uuid' Acquia_Cloud_API_Documentation_DrushVersion: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_drush-version' Acquia_Cloud_API_Documentation_EnvironmentId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-id' Acquia_Cloud_API_Documentation_EnvironmentVariableName: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_environment-variable-name' Acquia_Cloud_API_Documentation_Filter: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter' Acquia_Cloud_API_Documentation_FilterStackMetrics: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-stack-metrics' Acquia_Cloud_API_Documentation_FilterUsageMetrics: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter-usage-metrics' Acquia_Cloud_API_Documentation_From: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from' Acquia_Cloud_API_Documentation_FromNoDefault: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from-no-default' Acquia_Cloud_API_Documentation_FromStackMetrics: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_from-stack-metrics' Acquia_Cloud_API_Documentation_IdeUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_ide-uuid' Acquia_Cloud_API_Documentation_IdentityProviderUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_identity-provider-uuid' Acquia_Cloud_API_Documentation_IndexId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_index-id' Acquia_Cloud_API_Documentation_Limit: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit' Acquia_Cloud_API_Documentation_LogForwardingDestinationUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid' Acquia_Cloud_API_Documentation_LogType: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_log-type' Acquia_Cloud_API_Documentation_MessageUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_message-uuid' Acquia_Cloud_API_Documentation_Name: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_name' Acquia_Cloud_API_Documentation_NotificationUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_notification-uuid' Acquia_Cloud_API_Documentation_Offset: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset' Acquia_Cloud_API_Documentation_OrganizationUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid' Acquia_Cloud_API_Documentation_Permission: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_permission' Acquia_Cloud_API_Documentation_Range: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_range' Acquia_Cloud_API_Documentation_Resolution: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_resolution' Acquia_Cloud_API_Documentation_RoleUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_role-uuid' Acquia_Cloud_API_Documentation_ServerId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-id' Acquia_Cloud_API_Documentation_ServerType: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_server-type' Acquia_Cloud_API_Documentation_ShieldAclUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_shield-acl-uuid' Acquia_Cloud_API_Documentation_SiteId: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_site-id' Acquia_Cloud_API_Documentation_Sort: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort' Acquia_Cloud_API_Documentation_SshKeyUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_ssh-key-uuid' Acquia_Cloud_API_Documentation_StackMetricsMetricType: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_stack-metrics-metric-type' Acquia_Cloud_API_Documentation_SubscriptionUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_subscription-uuid' Acquia_Cloud_API_Documentation_TagName: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_tag-name' Acquia_Cloud_API_Documentation_TeamUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' Acquia_Cloud_API_Documentation_To: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to' Acquia_Cloud_API_Documentation_ToNoDefault: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_to-no-default' Acquia_Cloud_API_Documentation_Token: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token' Acquia_Cloud_API_Documentation_TokenDeleteReason: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token-delete-reason' Acquia_Cloud_API_Documentation_TokenUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_token-uuid' Acquia_Cloud_API_Documentation_UsageMetric: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_usage-metric' Acquia_Cloud_API_Documentation_UserSearch: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-search' Acquia_Cloud_API_Documentation_UserUuid: $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid' Acquia_Cloud_API_Documentation_agreement-uuid: description: The entity's universally unique identifier. example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7 in: path name: agreementUuid required: true schema: type: string Acquia_Cloud_API_Documentation_alert-uuid: description: The entity's universally unique identifier. example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7 in: path name: alertUuid required: true schema: type: string Acquia_Cloud_API_Documentation_apm-type: description: The APM type. example: newrelic in: path name: apmType required: true schema: type: string Acquia_Cloud_API_Documentation_application-uuid: description: The entity's universally unique identifier. example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7 in: path name: applicationUuid required: true schema: type: string Acquia_Cloud_API_Documentation_artifact-id: description: An ID that uniquely identifies an artifact. example: drupal8 in: path name: artifactId required: true schema: type: string Acquia_Cloud_API_Documentation_backup-id: description: The database backup identifier. example: 1 in: path name: backupId required: true schema: type: integer Acquia_Cloud_API_Documentation_certificate-id: description: An ID that uniquely identifies a certificate. example: 7 in: path name: certificateId required: true schema: type: integer Acquia_Cloud_API_Documentation_configuration-set-id: description: An ID that uniquely identifies a configuration set. example: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 in: path name: configurationSetId required: true schema: type: string Acquia_Cloud_API_Documentation_cron-id: description: An ID that uniquely identifies a cron job. example: e10a665c-c9ec-4422-a82b-b32c82329f9d in: path name: cronId required: true schema: type: string Acquia_Cloud_API_Documentation_database-name: description: The database name, typically lower snake case. example: my_db in: path name: databaseName required: true schema: type: string Acquia_Cloud_API_Documentation_deprecated-from: deprecated: true description: (Use filter `from` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `to` query. example: '2019-10-01' in: query name: from required: false schema: type: string Acquia_Cloud_API_Documentation_deprecated-to: deprecated: true description: (Use filter `to` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `from` query. example: '2020-01-01' in: query name: to required: false schema: type: string Acquia_Cloud_API_Documentation_domain: description: A domain name. example: example.com in: path name: domain required: true schema: type: string Acquia_Cloud_API_Documentation_domain-registration-uuid: description: The Domain Registration universally unique identifier. example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7 in: path name: domainRegistrationUuid required: true schema: type: string Acquia_Cloud_API_Documentation_drush-version: description: Specifies the drush aliases formatting, either 8 (example.aliases.drushrc.php) or 9 (example.site.yaml) example: 8 in: query name: version required: true schema: enum: - 8 - 9 type: integer Acquia_Cloud_API_Documentation_environment-id: description: The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. example: 12-d314739e-296f-11e9-b210-d663bd873d93 in: path name: environmentId required: true schema: type: string Acquia_Cloud_API_Documentation_environment-variable-name: description: The environment variable name. example: EXAMPLE_VARIABLE_NAME in: path name: environmentVariableName required: true schema: maxLength: 255 minLength: 1 pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$ type: string Acquia_Cloud_API_Documentation_filter: 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. There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are: * Equals: `= (%3D)` * Does not equal: `!= (!%3D)` * Greater than: `> (%3E)` * Less than: `< (%3C)` * Greater than or equal to: `>= (%3E%3D)` * Less than or equal to: `<= (%3C%3D)` * Contains substring: `=@ (%3D@)` * Does not contain substring: `!@ (!@)` Filters 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 (`;`). Some examples: * `filter=field%3Dvalue` (`field` equals `''value''`) * `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`) * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`) * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals `''value''` AND `field2` > `5`) ' in: query name: filter required: false schema: minimum: 1 type: string Acquia_Cloud_API_Documentation_filter-stack-metrics: 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. There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are: * Equals: `= (%3D)` * Does not equal: `!= (!%3D)` * Greater than: `> (%3E)` * Less than: `< (%3C)` * Greater than or equal to: `>= (%3E%3D)` * Less than or equal to: `<= (%3C%3D)` * Contains substring: `=@ (%3D@)` * Does not contain substring: `!@ (!@)` Filters 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 (`;`). Some examples: * `filter=field%3Dvalue` (`field` equals `''value''`) * `filter=field%3D@*partialmatch` (`field` ends with `''partialmatch''`) * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `''partialmatch''` OR `field` equals `''value''`) * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `''partialmatch''` OR `field` equals `''value''` AND `field2` > `5`) **For this endpoint, the "metric" filter is required. Multiple metrics can be returned in one request. The following metrics are available:** * 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 ' in: query name: filter required: true schema: minimum: 1 type: string Acquia_Cloud_API_Documentation_filter-usage-metrics: 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. Filter parameters include: * `from` - Specifies absolute time period to retrieve results from. Requires ISO 8601 format. * `to` - Specifies absolute time period to retrieve results until. Requires ISO 8601 format. Formatting examples: * `2023-09-01` * `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`) Usage examples: * `{endpoint}?filter=from%3D2025-04-01,to%3D2025-04-30` (`from` is `2025-04-01` and `to` is `2025-04-30`) * `{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`) ' in: query name: filter required: false schema: minimum: 1 type: string Acquia_Cloud_API_Documentation_from: description: 'Specifies absolute time period to retrieve results from. Requires ISO 8601 format. Some examples: * `2023-09-01` * `2023-09-01T00%3A00%3A00.000Z` (`2023-09-01T00:00:00.000Z`) ' example: '2023-09-01' in: query name: from required: false schema: type: string Acquia_Cloud_API_Documentation_from-no-default: description: An ISO-8601 formatted date retrieve results from. example: '2021-01-29T22:45:21+00:00' in: query name: from required: false schema: type: string Acquia_Cloud_API_Documentation_from-stack-metrics: description: An ISO-8601 formatted date retrieve metrics from. example: '2021-01-29T22:45:21+00:00' in: query name: from required: true schema: type: string Acquia_Cloud_API_Documentation_ide-uuid: description: The Cloud IDE universally unique identifier. example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7 in: path name: ideUuid required: true schema: type: string Acquia_Cloud_API_Documentation_identity-provider-uuid: description: The entity's universally unique identifier. example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7 in: path name: identityProviderUuid required: true schema: type: string Acquia_Cloud_API_Documentation_index-id: description: An ID that uniquely identifies an index. example: ABCDE-1234.test.example in: path name: indexId required: true schema: type: string Acquia_Cloud_API_Documentation_limit: description: The maximum number of items to return. example: 10 in: query name: limit required: false schema: type: integer Acquia_Cloud_API_Documentation_log-forwarding-destination-uuid: description: The entity's universally unique identifier. example: dbd8a966-2b25-11e9-b210-d663bd873d93 in: path name: logForwardingDestinationUuid required: true schema: type: string Acquia_Cloud_API_Documentation_log-type: description: An ID that uniquely identifies a log type. example: php-error in: path name: logType required: true schema: enum: - apache-access - apache-error - drupal-request - drupal-watchdog - fpm-access - fpm-error - php-error - cloud-hook - cronjob - mysql-slow-query type: string Acquia_Cloud_API_Documentation_message-uuid: description: The entity's universally unique identifier. example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7 in: path name: messageUuid required: true schema: type: string Acquia_Cloud_API_Documentation_name: description: A name that uniquely identifies an entity. example: drupal8 in: path name: name required: true schema: type: string Acquia_Cloud_API_Documentation_notification-uuid: description: The entity's universally unique identifier. example: 2343b683-b194-4217-982a-6a95c72ad9a8 in: path name: notificationUuid required: true schema: format: uuid type: string Acquia_Cloud_API_Documentation_offset: description: An integer to signify the offset to paginate from. example: 10 in: query name: offset required: false schema: type: integer Acquia_Cloud_API_Documentation_organization-uuid: description: The organization entity's universally unique identifier. example: 1e7efab9-0fac-4a2c-ad94-61efc78623ba in: path name: organizationUuid required: true schema: format: uuid maxLength: 36 minLength: 36 type: string Acquia_Cloud_API_Documentation_permission: description: Specifies the permission you wish to check access for. example: deploy to prod in: query name: permission required: true schema: type: string Acquia_Cloud_API_Documentation_range: description: ISO-8601 date/time of invite create date/time. in: query name: range required: false schema: format: date-time type: string Acquia_Cloud_API_Documentation_resolution: description: 'Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month. Limits: - 3 hour limit for “minute” resolution - 1 week limit for “hour” resolution - 6 month limit for “day” resolution - 1 year limit for "week" resolution - 3 year limit for “month” resolution ' in: query name: resolution required: false schema: enum: - minute - hour - day - week - month type: string Acquia_Cloud_API_Documentation_role-uuid: description: The entity's universally unique identifier. example: da1c0a8e-ff69-45db-88fc-acd6d2affbb7 in: path name: roleUuid required: true schema: type: string Acquia_Cloud_API_Documentation_server-id: description: The internal database identifier of the server. example: '42' in: path name: serverId required: true schema: type: string Acquia_Cloud_API_Documentation_server-type: description: Specifies the type of server metric to retrieve. example: web in: query name: serverType required: true schema: enum: - web - bal - db type: string Acquia_Cloud_API_Documentation_shield-acl-uuid: description: The entity's universally unique identifier. example: a1234567-1234-123a-abc1-12ab345cd678 in: path name: shieldAclUuid required: true schema: type: string Acquia_Cloud_API_Documentation_site-id: description: The site id example: 1938d81b-4b14-462d-9871-5f8a32eb59b3 in: path name: siteId required: true schema: type: string Acquia_Cloud_API_Documentation_sort: 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. ' example: field1,-field2 in: query name: sort required: false schema: minimum: 1 type: string Acquia_Cloud_API_Documentation_ssh-key-uuid: description: The SSH key entity's universally unique identifier. example: 981b7910-2fe9-11e9-b210-d663bd873d93 in: path name: sshKeyUuid required: true schema: type: string Acquia_Cloud_API_Documentation_stack-metrics-metric-type: description: Specifies the type of StackMetrics metric to retrieve. example: - web-cpu - web-memory in: path name: stackMetricsMetricType required: true schema: items: enum: - 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 type: string type: array Acquia_Cloud_API_Documentation_subscription-uuid: description: The subscription entity's universally unique identifier. example: 0f3ad33e-2fe4-11e9-b210-d663bd873d93 in: path name: subscriptionUuid required: true schema: type: string Acquia_Cloud_API_Documentation_tag-name: description: The name of the application tag. example: green in: path name: tagName required: true schema: type: string Acquia_Cloud_API_Documentation_team-uuid: description: The entity's universally unique identifier. example: 3eef5d81-62f4-429c-aa94-e17d05ab4740 in: path name: teamUuid required: true schema: type: string Acquia_Cloud_API_Documentation_to: description: 'Optionally specifies absolute time period to retrieve results until. Requires ISO 8601 format. Some examples: * `2023-09-29` * `2023-09-29T00%3A00%3A00.000Z` (`2023-09-29T00:00:00.000Z`) ' example: '2023-09-29' in: query name: to required: false schema: type: string Acquia_Cloud_API_Documentation_to-no-default: description: An ISO-8601 formatted date retrieve results to. example: '2021-01-29T23:55:21+00:00' in: query name: to required: false schema: type: string Acquia_Cloud_API_Documentation_token: description: The token identifier. in: path name: token required: true schema: type: string Acquia_Cloud_API_Documentation_token-delete-reason: description: Specifies the reason for the token revocation for future reference. example: The quick brown fox jumped over the lazy dog. in: query name: tokenDeleteReason schema: type: string Acquia_Cloud_API_Documentation_token-uuid: description: The token entity's universally unique identifier. example: 882f3258-2fe9-11e9-b210-d663bd873d93 in: path name: tokenUuid required: true schema: type: string Acquia_Cloud_API_Documentation_usage-metric: description: A usage data metric type. example: views in: path name: usageMetric required: true schema: type: string Acquia_Cloud_API_Documentation_user-search: description: The user's username, email, name, or token. This can be a partial match. example: john doe in: query name: userSearch required: true schema: type: string Acquia_Cloud_API_Documentation_user-uuid: description: The entity's universally unique identifier. example: f2daa9cc-e5a0-4036-a5c8-f96e336c62b5 in: path name: userUuid required: true schema: type: string Private_Network_Service_API_Filter: description: 'Filter the result set using field-based criteria. **Format:** `field:value`, `field=value` or `field:operator:value` **Logical operators:** - `,` (comma) - OR logic between filters - `;` (semicolon) - AND logic between filters - **Note:** Cannot mix OR and AND operators in the same query **Comparison operators:** - `=` - Equals (default if no operator specified) - `!=` - Does not equal - `>` - Greater than - `<` - Less than - `>=` - Greater than or equal to - `<=` - Less than or equal to - `=@` - Contains substring - `!@` - Does not contain substring **Wildcards:** - `*` - Wildcard character for pattern matching **Examples:** - `status=active` - Filter by status equals active - `name=@prod` - Filter by name containing "prod" - `status=active;type=standard` - Status is active AND type is standard - `status=active,status=pending` - Status is active OR pending ' example: status:active;type:standard in: query name: filter required: false schema: pattern: ^([a-zA-Z0-9_]+[:=](?:[a-zA-Z0-9_\-*]+|[>https://docs.acquia.com/acquia-cloud/develop/api/auth/\n\ \n### Example implementation\n\nAn example PHP script for making authenticated\ \ API requests can be found here. This script uses the League/oauth2-client library, installed via Composer.\n" title: Acquia Cloud API - Teams and Permissions version: 2.0.0 x-logo: altText: Acquia Cloud backgroundColor: '#FFFFFF' url: assets/cloud-platform.svg openapi: 3.0.0 paths: /permissions: get: description: 'Displays a list of all available permissions currently in the system. This will include permissions that the user may not have access to. ' operationId: getPermissions responses: '200': content: application/hal+json: example: _embedded: items: - description: Grants the ability to enable or disable live development and non-production work. flags: deprecated: false group_label: Workflow label: Pull and deploy code, files, or databases to non-production environments name: deploy to non-prod - description: null flags: deprecated: false group_label: Workflow label: Deploy code, files, or databases to the production environment name: deploy to prod - description: null flags: deprecated: false group_label: Workflow label: Pull files or databases from the production environment name: pull from prod - description: null flags: deprecated: false group_label: Workflow label: Move files to non-production environments name: move file to non-prod - description: null flags: deprecated: false group_label: Workflow label: Move files to the production environment name: move file to prod - description: null flags: deprecated: false group_label: Workflow label: Move files from production environments name: move file from prod - description: null flags: deprecated: false group_label: Workflow label: Move files from non-production environments name: move file from non-prod - description: null flags: deprecated: true group_label: Workflow label: Clear Varnish cache for non-production environments name: clear varnish on non-prod - description: null flags: deprecated: true group_label: Workflow label: Clear Varnish cache for the production environment name: clear varnish on prod - description: null flags: deprecated: false group_label: Workflow label: Configure production environment name: configure prod env - description: null flags: deprecated: false group_label: Workflow label: Configure non-production environments name: configure non-prod env - description: null flags: deprecated: false group_label: Workflow label: Add an environment name: add an environment - description: null flags: deprecated: false group_label: Workflow label: Delete an environment name: delete an environment - description: null flags: deprecated: false group_label: Domains label: Add or remove domains for non-production environments name: administer domain non-prod - description: null flags: deprecated: false group_label: Domains label: Add or remove domains for the production environment name: administer domain prod - description: null flags: deprecated: false group_label: Domains label: Add or remove SSL certificates for the production environment name: administer ssl prod - description: null flags: deprecated: false group_label: Domains label: Add or remove SSL certificates for the non-production environments name: administer ssl non-prod - description: null flags: deprecated: false group_label: Server administration label: Reboot server name: reboot server - description: Increasing the size of your server costs money. flags: deprecated: false group_label: Server administration label: Resize server name: resize server - description: null flags: deprecated: false group_label: Server administration label: Suspend server name: suspend server - description: null flags: deprecated: false group_label: Server administration label: Configure server name: configure server - description: null flags: deprecated: false group_label: Logs label: Download logs for non-production environments name: download logs non-prod - description: null flags: deprecated: false group_label: Logs label: Download logs for the production environment name: download logs prod - description: null flags: deprecated: false group_label: Databases label: Add a database name: add database - description: null flags: deprecated: false group_label: Databases label: Remove a database name: remove database - description: null flags: deprecated: false group_label: Databases label: View database connection details (username, password, or hostname) name: view database connection - description: null flags: deprecated: false group_label: Databases label: Download database backups for non-production environments name: download db backup non-prod - description: null flags: deprecated: false group_label: Databases label: Download database backups for the production environment name: download db backup prod - description: null flags: deprecated: false group_label: Databases label: Create database backups for non-production environments name: create db backup non-prod - description: null flags: deprecated: false group_label: Databases label: Create database backups for the production environment name: create db backup prod - description: null flags: deprecated: false group_label: Databases label: Restore database backups for non-production environments name: restore db backup non-prod - description: null flags: deprecated: false group_label: Databases label: Restore database backups for the production environment name: restore db backup prod - description: Granting this permission will give any user with this role full permissions on this team. flags: deprecated: false group_label: Administration label: Add or remove a user of a team name: administer team - description: Grants the ability to use the API and bypass all other permissions via command line tools. flags: deprecated: false group_label: Administration label: Access the Cloud API name: access cloud api - description: null flags: deprecated: false group_label: Cron label: Modify cron tasks for non-production environments name: administer cron non-prod - description: null flags: deprecated: false group_label: Cron label: Modify cron tasks for the production environment name: administer cron prod - description: null flags: deprecated: false group_label: Support label: Create a support ticket name: create support ticket - description: null flags: deprecated: false group_label: Support label: View and edit any support tickets for a subscription name: edit any support ticket - description: null flags: deprecated: false group_label: Build label: View Build plans name: view build plans - description: null flags: deprecated: false group_label: Build label: Edit Build plans name: edit build plans - description: null flags: deprecated: false group_label: Build label: Run Build plans name: run build plans - description: null flags: deprecated: false group_label: SSH keys label: Add SSH key to git repository name: add ssh key to git - description: null flags: deprecated: false group_label: SSH keys label: Add SSH key to non-production environments name: add ssh key to non-prod - description: null flags: deprecated: false group_label: SSH keys label: Add SSH key to the production environment name: add ssh key to prod - description: This permission is only relevant if your subscription has remote administration. flags: deprecated: false group_label: Administration label: View Remote Administration name: view remote administration - description: This permission is only relevant if your subscription has remote administration. flags: deprecated: false group_label: Administration label: Edit Remote Administration name: edit remote administration - description: null flags: deprecated: false group_label: Workflow label: Clear caches for the production environment name: clear caches on prod - description: null flags: deprecated: false group_label: Workflow label: Clear caches for non-production environments name: clear caches on non-prod _links: self: href: https://cloud.acquia.com/api/permissions total: 49 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_permissions' description: OK summary: Acquia Return a List of Permissions. tags: - Teams and Permissions x-cli-name: permissions:list /roles/{roleUuid}: delete: description: Deletes a specific role. operationId: deleteRole parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_role-uuid' responses: '200': content: application/hal+json: example: message: Deleted role. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '404': content: application/hal+json: examples: Role not found: value: error: not_found message: The role you are trying to delete does not exist, or you do not have permission to delete it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Deletes a Specific Role by its UUID. tags: - Teams and Permissions x-cli-name: tps:roles-delete get: description: 'Roles may be assigned to team members, and grant various permissions to the applications that the team is assigned to. Roles are unique within a organization. ' operationId: getRole parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_role-uuid' responses: '200': content: application/hal+json: example: description: Some details about my custom role. flags: default: false last_edited: edited_at: '2011-03-28T13:09:41-04:00' user: first_name: Jane last_name: Doe mail: jane.doe@example.com picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com username: jane.doe uuid: 590909a0-e819-43e6-a8e3-212dc3e35852 name: My Custom Role organization: name: My Organization uuid: d122cc06-35bd-41bf-9baa-5b770c8ca0f1 permissions: - description: Grants the ability to enable or disable live development and non-production work. flags: deprecated: false group_label: Workflow label: Pull and deploy code, files, or databases to non-production environments name: deploy to non-prod - description: null flags: deprecated: false group_label: Workflow label: Configure non-production environments name: configure non-prod env - description: null flags: deprecated: false group_label: Logs label: Download logs for non-production environments name: download logs non-prod - description: null flags: deprecated: false group_label: Databases label: View database connection details (username, password, or hostname) name: view database connection uuid: c885728d-cbbe-4e54-bf09-19b751b6d0c7 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_role' description: OK '404': content: application/hal+json: examples: Role not found: value: error: not_found message: The role you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Return Details About a Specific Role. tags: - Teams and Permissions x-cli-name: tps:role-find put: description: Modifies a role. operationId: putRoleByUuid parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_role-uuid' requestBody: content: application/hal+json: example: description: My new role description. name: My new role name permisions: - permission 4 - permission 5 schema: properties: description: description: The new description of the role. maxLength: 255 minLength: 1 type: string name: description: The new name of the role. maxLength: 255 minLength: 1 type: string permissions: description: An array of the permissions associated with the role. items: type: string type: array type: object application/x-www-form-urlencoded: example: name: My new application name schema: example: description: My new role description. name: My new role name status: - permission 4 - permission 5 properties: description: description: The updated description of the role. maxLength: 255 minLength: 1 type: string name: description: The updated name of the role. maxLength: 255 minLength: 1 type: string permissions: description: A list of permissions to grant to this role. items: type: string type: array type: object required: true responses: '200': content: application/hal+json: example: message: Updating role. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '404': content: application/hal+json: examples: Role not found: value: error: not_found message: The role you are trying to access does not exist, or you do not have permission to edit it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Updates a Role. tags: - Teams and Permissions x-cli-name: tps:role-update /teams: get: description: 'Returns a list of teams the current user has access to. Filterable fields: * `name` Sortable fields: * `name` ' operationId: getTeams parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_range' responses: '200': content: application/hal+json: example: _embedded: items: - _links: self: href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c created_at: 2013-10-28T14:16:07-0700 name: Team Name 1 organization: name: Sample Organization uuid: 2375e327-3fff-11e3-9170-12313920a02c updated_at: 2015-02-19T08:53:10-0800 uuid: abcd1234-82b5-11e3-9170-12313920a02c - _links: self: href: https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f created_at: 2014-05-27T11:55:39-0700 name: Team Name 2 organization: name: Sample Organization uuid: 2375e327-3fff-11e3-9170-12313920a02c updated_at: 2015-01-30T05:49:16-0800 uuid: 1234abcd-82b5-11e3-9170-12313920a02c _links: self: href: https://cloud.acquia.com/api/teams total: 2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_teams' description: OK '403': content: application/hal+json: examples: No permission: value: error: forbidden message: You do not have permission to view teams. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Return Teams the Current User Has Access To. tags: - Teams and Permissions x-cli-name: tps:teams-list /teams/{teamUuid}: delete: description: Deletes a specific team by its UUID. operationId: deleteTeam parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' responses: '200': content: application/hal+json: examples: Removed team: value: message: Removed team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '404': content: application/hal+json: examples: Team not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to remove it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Deletes a Specific Team by its UUID. tags: - Teams and Permissions x-cli-name: tps:team-delete get: description: Return details about a specific team. operationId: getTeam parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' responses: '200': content: application/hal+json: example: _embedded: organization: - _links: self: href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c name: Sample Organization uuid: 2375e327-3fff-11e3-9170-12313920a02c _links: applications: href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/applications invites: href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/invites members: href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/members parent: href: https://cloud.acquia.com/api/teams self: href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c created_at: 2013-10-28T14:16:07-0700 name: Sample Team organization: name: Sample Organization uuid: 2375e327-3fff-11e3-9170-12313920a02c updated_at: 2015-02-19T08:53:10-0800 uuid: 2c9ea556-4016-11e3-9170-12313920a02c schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team' description: OK '404': content: application/hal+json: examples: Role not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Return Details About a Specific Team. tags: - Teams and Permissions x-cli-name: tps:team-find put: description: Change the name of a team. operationId: putTeamsName parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' requestBody: content: application/hal+json: example: name: My new team name schema: properties: name: description: The new name of the team. maxLength: 255 minLength: 1 type: string type: object application/x-www-form-urlencoded: example: name: My new team name schema: properties: name: description: The new name of the team. maxLength: 255 minLength: 1 type: string type: object required: true responses: '200': content: application/hal+json: examples: Team renamed: value: message: Team renamed. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '404': content: application/hal+json: examples: Role not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to rename it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Change the Name of a Team. tags: - Teams and Permissions x-cli-name: tps:team-update /teams/{teamUuid}/actions/leave: post: description: Removes the current user from a team. operationId: postLeaveTeam parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' responses: '200': content: application/hal+json: examples: Left team: value: message: You have left the team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '404': content: application/hal+json: examples: Invalid team: value: error: not_found message: Invalid team supplied. No action performed. Invalid user: value: error: not_found message: Invalid user supplied. No action performed. Not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to access it. User not on team: value: error: not_found message: The user is not a member of this team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Removes the Current User from a Team. tags: - Teams and Permissions x-cli-name: tps:user-leave /teams/{teamUuid}/applications: get: description: 'Returns a list of applications this team has access to. Filterable fields: * `name` Sortable fields: * `name` ' operationId: getTeamApplications parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset' responses: '200': content: application/hal+json: example: _embedded: items: - _links: self: href: https://cloud.acquia.com/api/applications/50cf9819-6f99-4ef2-be10-1a85dc354ca1 flags: remote_admin: true hosting: id: devcloud:devcloud2 type: acp id: 241643 name: Sample application 1 organization: name: Sample organization uuid: 434aac3d-bb5f-44d1-bea4-398addbf5a04 status: normal subscription: name: Sample subscription uuid: fc04cc3e-8d91-4fb4-a8dd-15dc81df7458 type: drupal uuid: 50cf9819-6f99-4ef2-be10-1a85dc354ca1 - _links: self: href: https://cloud.acquia.com/api/teams/a47ac10b-58cc-4372-a567-0e02b2c3d471/applications flags: remote_admin: false hosting: id: devcloud:devcloud2 type: free id: 954291 name: Sample application 2 organization: name: Sample organization uuid: 434aac3d-bb5f-44d1-bea4-398addbf5a04 status: provisioning subscription: name: Sample subscription uuid: fc04cc3e-8d91-4fb4-a8dd-15dc81df7458 type: drupal uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471 _links: filter: href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?filter} templated: true limit: href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?limit} templated: true parent: href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5 self: href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications sort: href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?sort} templated: true pagination: limit: 10 offset: 0 total: 2 total: 2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-applications' description: OK '404': content: application/hal+json: examples: Not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found summary: Acquia Returns a List of Applications This Team Has Access To. tags: - Teams and Permissions x-cli-name: tps:team-application-list post: description: Adds an application to this team. operationId: postTeamAddApplication parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' requestBody: content: application/hal+json: example: uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470 schema: properties: uuid: description: The uuid of the application to add to this team. format: uuid maxLength: 36 minLength: 36 type: string required: - uuid type: object application/x-www-form-urlencoded: example: uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470 schema: properties: uuid: description: The uuid of the application to add to this team. format: uuid maxLength: 36 minLength: 36 type: string required: - uuid type: object required: true responses: '200': content: application/hal+json: examples: Added application: value: message: Added application to team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '403': content: application/hal+json: examples: Not found: value: error: forbidden message: The application you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Application mismatch: value: error: not_found message: The application must belong to the same organization as this team. Not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found '409': content: application/hal+json: examples: Application already on team: value: error: conflict message: The application is already on this team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Conflict security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Adds an Application to This Team. tags: - Teams and Permissions x-cli-name: tps:team-application-add /teams/{teamUuid}/applications/{applicationUuid}: delete: description: Removes the application from this team. Team members will immediately lose access to this application. operationId: deleteTeamsRemoveApplication parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_application-uuid' responses: '200': content: application/hal+json: examples: Removed application: value: message: Removed application from team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '403': content: application/hal+json: examples: Not found: value: error: forbidden message: The application you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Application mismatch: value: error: not_found message: The application is not associated with this team. Team not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Removes the Application from This Team. tags: - Teams and Permissions x-cli-name: tps:team-application-remove /teams/{teamUuid}/invites: get: description: 'Returns a list of invitations to this team. Filterable fields: * `mail` * `token` * `author` Sortable fields: * `mail` * `token` * `author` ' operationId: getTeamInvites parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_range' responses: '200': content: application/hal+json: example: _embedded: items: - _links: self: href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ec applications: - name: Main Application uuid: 88dc87db-1169-4908-9384-2328a7bd5cc1 author: first_name: Jane last_name: Doe mail: jane.doe@example.com picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com username: jane.doe uuid: ff4d12d9-1aba-472a-b0d1-ba19342922fa created_at: '2012-05-15T12:00:00Z' email: invitee@example.com flags: declined: true organization: name: Organization Name uuid: 3f3fc2da-bb2b-473c-aa5c-8b9d8fa6c7b8 roles: - name: Senior Developer uuid: aba649d1-795e-4472-87c8-7b32536c71b3 - name: Team Lead uuid: a70a0192-c962-421a-b534-393c245ba142 team: name: Team Name uuid: 9ab05712-29b7-4171-8168-2ed085ea32b2 token: dd9ea69fdcb6bee08b31a858b85535ec uuid: f4347e76-bcd7-41f6-91aa-ac6691755f0c - _links: self: href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed applications: - name: Main Application uuid: 88dc87db-1169-4908-9384-2328a7bd5cc1 - name: Secondary Application uuid: a2345672-58cc-4372-a567-0e02b2c3d470 author: first_name: John last_name: Doe mail: john.doe@example.com picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=john.doe@example.com username: john.doe uuid: 80363753-76dc-486c-b942-57ff9fc131ee created_at: '2012-05-15T12:00:00Z' email: invitee2@example.com flags: declined: false organization: name: Organization Name uuid: 3f3fc2da-bb2b-473c-aa5c-8b9d8fa6c7b8 roles: - name: Senior Developer uuid: aba649d1-795e-4472-87c8-7b32536c71b3 team: name: Team Name uuid: 9ab05712-29b7-4171-8168-2ed085ea32b2 token: dd9ea69fdcb6bee08b31a858b85535ed uuid: 6bf96944-bb9b-4629-b593-d658e44d8054 _links: filter: href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?filter} templated: true limit: href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?limit} templated: true parent: href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625 self: href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites sort: href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?sort} templated: true total: 2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-invites' description: OK '403': content: application/hal+json: examples: No permission: value: error: forbidden message: You do not have permission to view invites for this team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found summary: Acquia Returns a List of Invitations to This Team. tags: - Teams and Permissions x-cli-name: tps:team-invite-list post: description: Invites a user to join a team. operationId: postTeamsInviteUser parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' requestBody: content: application/hal+json: example: email: person@example.com roles: - 489efe35-7bb7-48b7-9aa2-f6f8f457c926 - 8025e9a7-781a-4ad1-b7ea-1f1b732944c2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-invite' application/x-www-form-urlencoded: example: email: person@example.com roles: - 489efe35-7bb7-48b7-9aa2-f6f8f457c926 - 8025e9a7-781a-4ad1-b7ea-1f1b732944c2 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_post-invite' required: true responses: '200': content: application/hal+json: examples: Invited: value: message: Invited team member. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '201': content: application/hal+json: schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_invite' description: Created '400': content: application/hal+json: examples: Invalid parameter: value: error: validation_failed message: name: 'Invalid values for parameter(s): example_param' Missing parameter: value: error: validation_failed message: name: 'Missing required parameter(s): example_param' schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error' description: Bad Request '403': content: application/hal+json: examples: Insufficient permissions: value: error: forbidden message: You do not have permission to invite users to this team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Role not found: value: error: not_found message: One or more of the chosen roles do not belong to this organization. Team not found: value: error: not_found message: The team you are trying to modify does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found '409': content: application/hal+json: examples: Invitation already sent: value: error: conflict message: An invitation to person@example.com has already been sent. It was sent on May 6, 2016 - 7:26pm. Must have at least one role: value: error: conflict message: A team member must be invited with at least one role. User already on team: value: error: conflict message: The user you are trying to invite already belongs to the team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Conflict security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Invites a User to Join a Team. tags: - Teams and Permissions x-cli-name: tps:team-user-invite /teams/{teamUuid}/members: get: description: 'Returns a list of team members. Filterable fields: * `permission` * `first_name` * `last_name` * `user` Sortable fields: * `permission` * `first_name` * `last_name` ' operationId: getTeamMembers parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_sort' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_filter' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_limit' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_offset' responses: '200': content: application/hal+json: example: _embedded: items: - first_name: James last_login_at: 2017-03-28T13:07:54-0500 last_name: Kirk mail: james.kirk@example.com picture_url: https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar roles: - name: Senior Developer uuid: 2d988ad3-4016-11e3-9170-12313920a02e username: james.kirk uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 - first_name: Christopher last_login_at: 2016-03-28T13:07:54-0500 last_name: Pike mail: chris.pike@example.com picture_url: https://accounts.acquia.com/images/users/30dacb5e-4122-11e1-9eb5-12313928d3c2/style/avatar roles: - name: Developer uuid: 3c9a1174-4016-11e3-9170-12313920a02d username: chris.pike uuid: 30dacb5e-4122-11e1-9eb5-12313928d3c2 - first_name: Jonathan last_login_at: null last_name: Archer mail: jonathan.archer@example.com picture_url: https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar roles: - name: Senior Developer uuid: 2d988ad3-4016-11e3-9170-12313920a02e - name: Developer uuid: 3c9a1174-4016-11e3-9170-12313920a02d username: jonathan.archer uuid: 3bcddc3a-52ba-4cce-aaa3-9adf721c1b52 _links: parent: href: https://cloud.acquia.com/api/teams/3c9ea553-3216-11e3-9170-12313920a23a self: href: https://cloud.acquia.com/api/teams/3c9ea553-3216-11e3-9170-12313920a23a/members total: 3 schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team-members' description: OK '404': content: application/hal+json: examples: Not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found summary: Acquia Returns a List of Team Members. tags: - Teams and Permissions x-cli-name: tps:team-member-list /teams/{teamUuid}/members/{userUuid}: delete: description: Remove a user from a team. operationId: deleteTeamsRemoveMember parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid' responses: '200': content: application/hal+json: examples: Team member removed: value: message: Team member removed. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '403': content: application/hal+json: examples: No permission: value: error: forbidden message: You do not have permission to remove team members. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Invalid team: value: error: not_found message: Invalid team supplied. No action performed. Invalid user: value: error: not_found message: Invalid user supplied. No action performed. Not found: value: error: not_found message: The team member you are trying to remove does not exist, or you do not have permission to remove them. User not team member: value: error: not_found message: The user is not a member of this team. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Remove a User from a Team. tags: - Teams and Permissions x-cli-name: tps:team-member-remove put: description: Grant team roles to a member. operationId: putTeamsMember parameters: - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_team-uuid' - $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid' requestBody: content: application/hal+json: example: roles: - 489efe35-7bb7-48b7-9aa2-f6f8f457c926 - 8025e9a7-781a-4ad1-b7ea-1f1b732944c2 schema: properties: roles: description: The role UUIDs to grant to the user. items: format: uuid maxLength: 36 minLength: 36 type: string type: array required: - roles type: object application/x-www-form-urlencoded: example: roles: - 489efe35-7bb7-48b7-9aa2-f6f8f457c926 - 8025e9a7-781a-4ad1-b7ea-1f1b732944c2 schema: properties: roles: description: The role UUIDs to grant to the user. items: format: uuid maxLength: 36 minLength: 36 type: string type: array required: - roles type: object required: true responses: '200': content: application/hal+json: examples: Modified member roles: value: message: Modified member roles. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message' description: OK '403': content: application/hal+json: examples: No permission: value: error: forbidden message: You do not have permission to modify team member roles. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Forbidden '404': content: application/hal+json: examples: Not found: value: error: not_found message: The team you are trying to access does not exist, or you do not have permission to access it. schema: $ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error' description: Not Found security: - Acquia_Cloud_API_Documentation_OAuth2: [] summary: Acquia Grant Team Roles to a Member. tags: - Teams and Permissions x-cli-name: tps:team-member-add servers: [] tags: - name: Teams and Permissions