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 - Organizations
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
openapi: 3.0.0
paths:
/organizations:
get:
description: 'An organization is a container for some or all of a customer''s
subscriptions. The owner of the organization is the
main billing contact. The owner, along with organization administrators, can
set up teams and roles to grant various
permissions to access the applications within each subscription in the organization.
Results can be filtered and
sorted by name.
'
operationId: getOrganizations
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
self:
href: https://cloud.acquia.com/api/organizations/bfafd31a-83a6-4257-b0ec-afdeff83117a
admins_total: 2
flags:
federated_authentication: false
id: '6'
name: Sample organization
owner:
first_name: First
last_name: Last
mail: user.name@example.com
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
roles_total: 4
subscriptions_total: 115
teams_total: 13
users_total: 82
uuid: bfafd31a-83a6-4257-b0ec-afdeff83117a
- _links:
self:
href: https://cloud.acquia.com/api/organizations/1992bfe6-c5bf-4a90-810e-a65acab42c6e
admins_total: 0
flags:
federated_authentication: true
id: '4841'
name: Sample organization 2
owner:
first_name: First
last_name: Last
mail: user.name@example.com
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
roles_total: 0
subscriptions_total: 4
teams_total: 0
users_total: 0
uuid: 1992bfe6-c5bf-4a90-810e-a65acab42c6e
- _links:
self:
href: https://cloud.acquia.com/api/organizations/3ff5a541-64cf-4334-acc7-af70b4374373
admins_total: 0
flags:
federated_authentication: false
id: '4841'
name: Sample organization 3
owner:
first_name: First
last_name: Last
mail: user.name@example.com
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd
roles_total: 0
subscriptions_total: 4
teams_total: 0
users_total: 0
uuid: 3ff5a541-64cf-4334-acc7-af70b4374373
_links:
filter:
href: https://cloud.acquia.com/api/organizations{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/
self:
href: https://cloud.acquia.com/api/organizations
sort:
href: https://cloud.acquia.com/api/organizations{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organizations'
description: OK
summary: Acquia Return a List of Organizations.
tags:
- Organizations
x-cli-name: organizations:list
/organizations/{organizationUuid}:
delete:
description: Deletes a specific organization.
operationId: deleteOrganization
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Deleted organization:
value:
message: Deleted organization.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'400':
content:
application/hal+json:
examples:
Associated subscriptions:
value:
error: validation_error
message:
general: This organization has associated subscriptions and
cannot be deleted.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'403':
content:
application/hal+json:
examples:
No Permission:
value:
error: forbidden
message: You do not have permission to delete this organization.
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 organization with UUID bfafd31a-83a6-4257-b0ec-afdeff83117a
does not exist.
Not Found or No Permission:
value:
error: not_found
message: The organization 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 Organization by its UUID.
tags:
- Organizations
x-cli-name: organizations:delete
get:
description: A specific organization.
operationId: getOrganizationByUuid
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
owner:
_links:
self:
href: https://cloud.acquia.com/api/users/98d56f28-cff0-421d-9985-58f15cbd6907
first_name: First
last_name: Last
mail: user.name@example.com
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 98d56f28-cff0-421d-9985-58f15cbd6907
_links:
admin-invites:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/admin-invites
admins:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/admins
applications:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/applications
identity-provider:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/identity-provider
members:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/members
parent:
href: https://cloud.acquia.com/api/organizations
roles:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/roles
self:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34
subscriptions:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/subscriptions
team-invites:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/team-invites
teams:
href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/teams
admins_total: 2
flags:
federated_authentication: false
id: '6'
name: Sample organization
owner:
first_name: First
last_name: Last
mail: user.name@example.com
picture_url: https://accounts.acquia.com/path/to/image.png
username: user.name
uuid: 98d56f28-cff0-421d-9985-58f15cbd6907
roles_total: 4
subscriptions_total: 115
teams_total: 13
users_total: 82
uuid: a81c08c6-a02f-4b57-87e3-c3f395a2bb34
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization'
description: OK
'404':
content:
application/hal+json:
example:
error: not_found
message: The organization 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 Organization.
tags:
- Organizations
x-cli-name: organizations:find
put:
description: Renames an organization.
operationId: putOrganization
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
content:
application/hal+json:
example:
name: My renamed organization
schema:
properties:
name:
description: The new name of the organization.
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
application/x-www-form-urlencoded:
example:
name: My renamed organization
schema:
properties:
name:
description: The new name of the organization.
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
required: true
responses:
'200':
content:
application/hal+json:
examples:
Organization renamed:
value:
message: Organization renamed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'400':
content:
application/hal+json:
examples:
Name unavailable:
value:
error: conflict
message:
name: The organization owner already has an organization with
this name.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Bad Request
'404':
content:
application/hal+json:
examples:
Not Found or Does Not Exist:
value:
error: not_found
message: The organization 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 Renames an Organization.
tags:
- Organizations
x-cli-name: organizations:update
/organizations/{organizationUuid}/actions/change-owner:
post:
description: Changes the organization owner.
operationId: postChangeOrganizationOwner
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
content:
application/hal+json:
schema:
properties:
user_uuid:
description: The uuid of the user you want to make the owner for
this organization.
format: uuid
type: string
required:
- user_uuid
type: object
application/x-www-form-urlencoded:
schema:
properties:
user_uuid:
description: The uuid of the user you want to make the owner for
this organization.
format: uuid
type: string
required:
- user_uuid
type: object
required: true
responses:
'200':
content:
application/hal+json:
examples:
Changed owner:
value:
message: Changed organization owner.
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 change the organization
owner.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No organization:
value:
error: not_found
message: The organization with UUID 07557159-264f-45eb-8f70-553b8ed21b16
does not exist.
No organization or permission:
value:
error: not_found
message: The organization you are trying to access does not exist,
or you do not have permission to access it.
No user:
value:
error: not_found
message: The user with UUID 3ba405e6-8621-4557-b78a-7d92baa79783
does not exist.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
New owner must be administrator:
value:
error: conflict
message: The new owner must be an existing administrator of the
organization.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Changes the Organization Owner.
tags:
- Organizations
x-cli-name: organizations:owner-change
/organizations/{organizationUuid}/actions/leave:
post:
description: Removes your account from an organization.
operationId: postLeaveOrganization
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Left organization:
value:
message: Left organization.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'404':
content:
application/hal+json:
examples:
No organization:
value:
error: not_found
message: The organization with UUID 07557159-264f-45eb-8f70-553b8ed21b16
does not exist.
No organization or permission:
value:
error: not_found
message: The organization you are trying to access does not exist,
or you do not have permission to access it.
No user:
value:
error: not_found
message: The user with UUID 3ba405e6-8621-4557-b78a-7d92baa79783
does not exist.
Not a member:
value:
error: not_found
message: You are not a member of this organization.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Organization owner cannot be removed:
value:
error: conflict
message: The organization owner cannot be removed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Removes Your Account from an Organization.
tags:
- Organizations
x-cli-name: organizations:leave
/organizations/{organizationUuid}/admin-invites:
get:
description: 'Gets a list of invitations of administrators for this organization.
Filterable fields:
* `first_name`
* `last_name`
* `permission`
Sortable fields:
* `first_name`
* `last_name`
* `permission`
'
operationId: getOrganizationAdminInvites
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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
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: 0f1915e8-cd84-4386-94b8-21926fc376f5
created_at: '2012-05-15T12:00:00Z'
email: invitee@example.com
flags:
declined: false
organization:
name: Organization Name
uuid: a45a99ce-e1ae-47ac-a570-8189bc4d3347
token: dd9ea69fdcb6bee08b31a858b85535ec
uuid: f921fa88-47e3-49df-9dbb-75950aaca428
- _links:
self:
href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed
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: 3f694d6e-3aec-4408-a04f-26ac026118d9
created_at: '2012-05-15T12:00:00Z'
email: invitee2@example.com
flags:
declined: false
organization:
name: Organization Name
uuid: a45a99ce-e1ae-47ac-a570-8189bc4d3347
token: dd9ea69fdcb6bee08b31a858b85535ed
uuid: 857a8ec9-ac33-428d-8b1c-718d7f6f9aa4
_links:
parent:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admin-invites
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-invites'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Gets a List of Invitations of Administrators for This Organization.
tags:
- Organizations
x-cli-name: organizations:admin-invite-list
post:
description: Invites a user to be an administrator in this organization.
operationId: postOrganizationAdminInvite
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
content:
application/hal+json:
example:
email: invitee@example.com
schema:
properties:
email:
description: The email address of the user to invite as an administrator
for this organization.
maxLength: 255
minLength: 1
type: string
required:
- email
type: object
application/x-www-form-urlencoded:
example:
email: invitee@example.com
schema:
properties:
email:
description: The email address of the user to invite as an administrator
for this organization.
maxLength: 255
minLength: 1
type: string
required:
- email
type: object
required: true
responses:
'200':
content:
application/hal+json:
examples:
Role created:
value:
message: Invited organization administrator.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: Accepted
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization you are trying to retrieve 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:
Missing team:
value:
error: conflict
message: An invitation to test@example.com has already been sent.
It was sent on May 6, 2016 - 7:26pm.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Invites a User to Be an Administrator in This Organization.
tags:
- Organizations
x-cli-name: organizations:admin-invite-create
/organizations/{organizationUuid}/admins:
get:
description: 'Returns a list of organization administrators.
Filterable fields:
* `first_name`
* `last_name`
* `mail`
* `username`
Sortable fields:
* `first_name`
* `last_name`
* `mail`
* `username`
'
operationId: getOrganizationAdmins
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
first_name: James
flags:
owner: true
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
username: james.kirk
uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
- _links:
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/30dacb5e-4122-11e1-9eb5-12313928d3c2
first_name: Christopher
flags:
owner: false
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
username: chris.pike
uuid: 30dacb5e-4122-11e1-9eb5-12313928d3c2
- _links:
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52
first_name: Jonathan
flags:
owner: false
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
username: jonathan.archer
uuid: 3bcddc3a-52ba-4cce-aaa3-9adf721c1b52
_links:
parent:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-user-profiles'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Returns a List of Organization Administrators.
tags:
- Organizations
x-cli-name: organizations:admin-list
/organizations/{organizationUuid}/admins/{userUuid}:
delete:
description: Removes the user from the list of administrators for the organization.
operationId: deleteOrganizationAdmin
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Member removed:
value:
message: Organization administrator removed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'404':
content:
application/hal+json:
examples:
No organization or permission:
value:
error: not_found
message: The organization you are trying to administer does not
exist, or you do not have permission to administer it.
Organization not found:
value:
error: not_found
message: The organization with UUID 653077de-9349-4822-a104-5e5a8dd2ba05
does not exist.
User mismatch:
value:
error: validation_failed
message: The user is not an administrator for this organization.
User not found:
value:
error: not_found
message: The user with UUID 5404f30f-465c-4d94-80f1-61f1d35fde0b
does not exist.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Removes the User from the List of Administrators for the Organization.
tags:
- Organizations
x-cli-name: organizations:admin-delete
get:
description: Returns the user profile of this organization administrator.
operationId: getOrganizationAdmin
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
parent:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/admins
self:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/admins/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
first_name: James
flags:
owner: true
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
username: james.kirk
uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-admin-user-profile'
description: OK
'403':
content:
application/hal+json:
examples:
No permission:
value:
error: forbidden
message: You do not have permission to view this administrator.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found or no permission:
value:
error: not_found
message: The organization 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 Returns the User Profile of This Organization Administrator.
tags:
- Organizations
x-cli-name: organizations:admin-find
/organizations/{organizationUuid}/applications:
get:
description: 'Returns a list of applications that belong to the organization.
Filterable fields:
* `name`
* `organization_name`
Sortable fields:
* `name`
* `organization_name`
'
operationId: getOrganizationApplications
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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/a47ac10b-58cc-4372-a567-0e02b2c3d470
flags:
remote_admin: true
hosting:
id: devcloud:devcloud2
type: acp
id: 241643
name: Sample application 1
organization:
name: Sample organization
uuid: d4e44648-8780-4105-905c-43a1eb486481
status: normal
subscription:
name: Sample subscription
uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471
flags:
remote_admin: false
hosting:
id: devcloud:devcloud2
type: free
id: 954291
name: Sample application 2
organization:
name: Sample organization
uuid: d4e44648-8780-4105-905c-43a1eb486481
status: provisioning
subscription:
name: Sample subscription
uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471
_links:
filter:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481
self:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications
sort:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?sort}
templated: true
pagination:
limit: 10
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-applications'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Returns a List of Applications That Belong to the Organization.
tags:
- Organizations
x-cli-name: organizations:applications-list
/organizations/{organizationUuid}/available-tags:
delete:
description: Deletes bulk tags from organization resources.
operationId: deleteOrganizationAvailableTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
content:
application/hal+json:
example:
context:
application:
uuids:
- 96e10bfb-1e4f-41c3-9d07-fffe8aba50d5
tags:
- name: tag-name-1
- name: tag-name-2
schema:
properties:
context:
description: Context resources of tags. Currently supports `application`
identifier and `uuids` type.
properties:
application:
description: The resource identifier for applications.
properties:
uuids:
description: A list of application uuids as a resource type.
items:
description: An application UUID.
format: uuid
maxLength: 36
minLength: 36
type: string
type: array
required:
- uuids
type: object
required:
- application
type: object
tags:
description: A list of tags to be deleted.
items:
description: Tag name object.
properties:
name:
description: The label of the tag.
maxLength: 16
minLength: 2
type: string
required:
- name
type: object
type: array
required:
- tags
- context
type: object
application/x-www-form-urlencoded:
example:
context:
application:
uuids:
- 96e10bfb-1e4f-41c3-9d07-fffe8aba50d5
tags:
- name: tag-name-1
- name: tag-name-2
schema:
properties:
context:
description: Context resources of tags. Currently supports `application`
identifier and `uuids` type.
properties:
application:
description: The resource identifier for applications.
properties:
uuids:
description: A list of application uuids as a resource type.
items:
description: An application UUID.
format: uuid
maxLength: 36
minLength: 36
type: string
type: array
required:
- uuids
type: object
required:
- application
type: object
tags:
description: A list of tags to be deleted.
items:
description: Tag object.
properties:
name:
description: The label of the tag.
maxLength: 16
minLength: 2
type: string
required:
- name
type: object
type: array
required:
- tags
- context
type: object
required: true
responses:
'200':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/154f88be-b9c0-47c4-b0cb-83eb6aebb7b7
parent:
href: https://cloud.acquia.com/api/organizations/1be8dcdf-e4fd-4a89-9d64-9e4486272c7a
self:
href: https://cloud.acquia.com/api/organizations/1be8dcdf-e4fd-4a89-9d64-9e4486272c7a/available-tags
message: Tags have been updated.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: OK
'403':
content:
application/hal+json:
examples:
Forbidden:
value:
error: forbidden
message: You do not have permission to remove tags from one or
more of the specified resources.
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 organization 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 Deletes Bulk Tags from Organization Resources.
tags:
- Organizations
x-cli-name: organizations:available-tags-delete
get:
description: Returns a list of all available application tags.
operationId: getOrganizationAvailableTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- color: orange
context:
application:
uuids:
- 185f07c7-9c4f-407b-8968-67892ebcb38a
organization:
uuids:
- 2375e327-3fff-11e3-9170-12313920a02c
name: Dev
_links:
filter:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c
self:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags
sort:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags{?sort}
templated: true
pagination:
limit: 1
offset: 0
total: 1
total: 1
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-available-tags'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Returns a List of All Available Application Tags.
tags:
- Organizations
x-cli-name: organizations:available-tags-list
post:
description: Adds bulk tags to organization resources.
operationId: postOrganizationAvailableTags
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
content:
application/hal+json:
example:
context:
application:
uuids:
- 96e10bfb-1e4f-41c3-9d07-fffe8aba50d5
tags:
- color: green
name: tag-name-1
- color: blue
name: tag-name-2
schema:
properties:
context:
description: Context resources of tags. Currently supports `application`
identifier and `uuids` type.
properties:
application:
description: The resource identifier for applications.
properties:
uuids:
description: A list of application uuids as a resource type.
items:
description: An application UUID.
format: uuid
maxLength: 36
minLength: 36
type: string
type: array
required:
- uuids
type: object
required:
- application
type: object
tags:
description: A list of tags to be added.
items:
description: Tag object.
properties:
color:
description: The color name of the tag found via the GET /api/options/colors
endpoint.
type: string
name:
description: The label of the tag.
maxLength: 16
minLength: 2
type: string
required:
- name
- color
type: object
type: array
required:
- tags
- context
type: object
application/x-www-form-urlencoded:
example:
context:
application:
uuids:
- 96e10bfb-1e4f-41c3-9d07-fffe8aba50d5
tags:
- color: green
name: tag-name-1
- color: blue
name: tag-name-2
schema:
properties:
context:
description: Context resources of tags. Currently supports `application`
identifier and `uuids` type.
properties:
application:
description: The resource identifier for applications.
properties:
uuids:
description: A list of application uuids as a resource type.
items:
description: An application UUID.
format: uuid
maxLength: 36
minLength: 36
type: string
type: array
required:
- uuids
type: object
required:
- application
type: object
tags:
description: A list of tags to be added.
items:
description: Tag object.
properties:
color:
description: The color name of the tag found via the GET /api/options/colors
endpoint.
type: string
name:
description: The label of the tag.
maxLength: 16
minLength: 2
type: string
required:
- name
- color
type: object
type: array
required:
- tags
- context
type: object
required: true
responses:
'201':
content:
application/hal+json:
example:
_links:
notification:
href: https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69
parent:
href: https://cloud.acquia.com/api/organizations/87c7be4d-d65d-4a5c-b36b-d921ca86c590
self:
href: https://cloud.acquia.com/api/organizations/87c7be4d-d65d-4a5c-b36b-d921ca86c590/available-tags
message: Tags have been updated.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message-with-links'
description: Accepted
'403':
content:
application/hal+json:
examples:
Forbidden:
value:
error: forbidden
message: You do not have permission to add tags to one or more
of the specified resources.
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 organization 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 Adds Bulk Tags to Organization Resources.
tags:
- Organizations
x-cli-name: organizations:available-tags-create
/organizations/{organizationUuid}/identity-provider:
get:
description: Returns an identity provider for an organization.
operationId: getOrganizationIdentityProvider
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
acs:
href: https://accounts.acquia.com/api/auth/saml/acs/1bc5dbb4-6d59-403b-afc7-777e520aaa40
parent:
href: https://cloud.acquia.com/api/identity-providers
self:
href: https://cloud.acquia.com/api/identity-providers/1bc5dbb4-6d59-403b-afc7-777e520aaa40
certificate: '-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----'
idp_entity_id: https://idp.example.com/saml
label: Test identity provider
sp_entity_id: https://sp.example.com/saml
sso_url: https://example.com/sso
status: enabled
uuid: 1bc5dbb4-6d59-403b-afc7-777e520aaa40
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_identity-provider'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The identity provider 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 Returns an Identity Provider for an Organization.
tags:
- Organizations
x-cli-name: organizations:identity-provider-find
/organizations/{organizationUuid}/members:
get:
description: 'Returns a list of all organization members, from all teams in
this organization.
Filterable fields:
* `first_name`
* `last_name`
* `permission`
Sortable fields:
* `first_name`
* `last_name`
* `permission`
'
operationId: getOrganizationMembers
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
self:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
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
teams:
- name: Team Name 1
roles:
- name: Senior Developer
uuid: 5f7da0a9-9ff0-4db8-802e-9d2b9969efc2
uuid: 26c4af83-545b-45cb-b165-d537adc9e0b4
username: james.kirk
uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3
- _links:
self:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/30dacb5e-4122-11e1-9eb5-12313928d3c2
first_name: Christopher
last_login_at: 2018-02-19T13: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
teams:
- name: Team Name 2
roles:
- name: Developer
uuid: d33cd9ff-281d-4bcf-9f89-b10b249caa35
uuid: af55adc6-14d4-4f10-92d7-99c673549935
username: chris.pike
uuid: 30dacb5e-4122-11e1-9eb5-12313928d3c2
- _links:
self:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52
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
teams:
- name: Team Name 1
roles:
- name: Team Lead
uuid: 312c0121-906b-4498-8402-7b479172768c
uuid: 26c4af83-545b-45cb-b165-d537adc9e0b4
- name: Team Name 2
roles:
- name: Developer
uuid: d33cd9ff-281d-4bcf-9f89-b10b249caa35
uuid: af55adc6-14d4-4f10-92d7-99c673549935
username: jonathan.archer
uuid: 3bcddc3a-52ba-4cce-aaa3-9adf721c1b52
_links:
filter:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/members{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/members{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a
self:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/members
sort:
href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/members{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-members'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Returns a List of All Organization Members.
tags:
- Organizations
x-cli-name: organizations:members-list
/organizations/{organizationUuid}/members/{userUuid}:
delete:
description: Removes the member from the organization.
operationId: postOrganizationMemberDelete
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
responses:
'200':
content:
application/hal+json:
examples:
Member removed:
value:
message: Organization member removed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'404':
content:
application/hal+json:
examples:
No organization or permission:
value:
error: not_found
message: The organization you are trying to administer does not
exist, or you do not have permission to administer it.
Organization not found:
value:
error: not_found
message: The organization with UUID 653077de-9349-4822-a104-5e5a8dd2ba05
does not exist.
User mismatch:
value:
error: not_found
message: The user is not a member of this organization.
User not found:
value:
error: not_found
message: The user with UUID 5404f30f-465c-4d94-80f1-61f1d35fde0b
does not exist.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Not Found
'409':
content:
application/hal+json:
examples:
Application mismatch:
value:
error: conflict
message: The organization owner cannot be removed.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Removes the Member from the Organization.
tags:
- Organizations
x-cli-name: organizations:member-delete
get:
description: Returns the user profile of this organization member.
operationId: getOrganizationMember
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
responses:
'200':
content:
application/hal+json:
example:
_links:
applications:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/applications
parent:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members
self:
href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52
first_name: Jonathan
last_login_at: 2017-03-28T13:07:54-0500
last_name: Archer
mail: jonathan.archer@example.com
picture_url: https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar
teams:
- name: Team Name 1
roles:
- name: Team Lead
uuid: 312c0121-906b-4498-8402-7b479172768c
uuid: 7325ba1a-5bfd-4341-9b23-55ffada3c131
- name: Team Name 2
roles:
- name: Developer
uuid: d33cd9ff-281d-4bcf-9f89-b10b249caa35
uuid: bca134fb-55d4-41ec-9558-d14531fa9899
username: jonathan.archer
uuid: 3bcddc3a-52ba-4cce-aaa3-9adf721c1b52
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-user-profile'
description: OK
'403':
content:
application/hal+json:
examples:
Not found:
value:
error: forbidden
message: You do not have permission to view this member.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
No organization or permission:
value:
error: not_found
message: The organization 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 Returns the User Profile of This Organization Member.
tags:
- Organizations
x-cli-name: organizations:member-find
/organizations/{organizationUuid}/members/{userUuid}/applications:
get:
description: Returns a list of applications that an organization member has
access to.
operationId: getOrganizationMemberApplications
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_user-uuid'
responses:
'200':
content:
application/hal+json:
example:
_embedded:
items:
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
flags:
remote_admin: true
hosting:
id: devcloud:devcloud2
type: acp
id: 241643
name: Sample application 1
organization:
name: Sample organization
uuid: d4e44648-8780-4105-905c-43a1eb486481
status: normal
subscription:
name: Sample subscription
uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471
flags:
remote_admin: false
hosting:
id: devcloud:devcloud2
type: free
id: 954291
name: Sample application 2
organization:
name: Sample organization
uuid: d4e44648-8780-4105-905c-43a1eb486481
status: provisioning
subscription:
name: Sample subscription
uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471
_links:
filter:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de/applications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de/applications{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de
self:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de/applications
sort:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de/applications{?sort}
templated: true
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications'
description: OK
'403':
content:
application/hal+json:
examples:
Not found or no permission:
value:
error: forbidden
message: You do not have permission to view the applications this
member has access to.
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 organization 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 Returns a List of Applications That an Organization Member Has
Access To.
tags:
- Organizations
x-cli-name: organizations:member-application-list
/organizations/{organizationUuid}/notifications:
get:
description: '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.
Filterable fields:
* `event`
* `label`
* `description`
* `status`
* `author`
* `created_at`
* `completed_at`
Sortable fields:
* `event`
* `label`
* `description`
* `status`
* `author`
* `created_at`
* `completed_at`
'
operationId: getOrganizationNotifications
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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:
organization/json:
example:
_embedded:
items:
- _embedded:
author:
created_at: '2019-10-15T20:22:19+00:00'
email: thomas.a.anderson@acquia.com
first_name: Thomas
last_login_at: '2022-11-30T16:22:48+00:00'
last_name: Anderson
picture_url: https://accounts.acquia.com/images/users/08a44409-568f-46f6-8038-4f30e19e3eb2/style/avatar
username: thomas.a.anderson@acquia.com
uuid: 08a44409-568f-46f6-8038-4f30e19e3eb2
_links:
parent:
href: https://cloud.acquia.com/api/notifications
self:
href: https://cloud.acquia.com/api/notifications/5c5e848b-296a-4c64-94aa-5a97d99da189
completed_at: '2022-12-08T15:42:37+00:00'
context:
author:
actual_uuid: 08a44409-568f-46f6-8038-4f30e19e3eb2
uuid: 08a44409-568f-46f6-8038-4f30e19e3eb2
organization:
uuids:
- 2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d
role:
uuids:
- 8095f9db-5f02-4338-9e90-7772715b5345
- b9f366a5-210f-41ad-b99f-feaa61e71394
- ddd251c6-5095-4cdb-8902-b3839edfffb4
- 3c4b2884-60c8-4ca3-9be5-b01c0159658c
- 3cb1519a-20be-4f69-8a5f-4037dff0acd1
- 1dd0f44b-6118-4c95-a3a2-a9deea32b2b0
team:
new_name: project anomaly
uuids:
- 4002d7cb-9c89-42f8-8515-4cfc3eb03230
user:
uuids:
- 08a44409-568f-46f6-8038-4f30e19e3eb2
created_at: '2022-12-08T15:42:37+00:00'
description: Created a new team project anomaly.
event: TeamCreated
label: Team created
progress: 100
status: completed
uuid: 5c5e848b-296a-4c64-94aa-5a97d99da189
_links:
filter:
href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d
self:
href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications
sort:
href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications{?sort}
templated: true
pagination:
limit: 1
offset: 0
total: 1
total: 1
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organizations-notifications'
description: OK
'404':
content:
organization/json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Notifications Associated with This Organization
by its UUID.
tags:
- Organizations
x-cli-name: organizations:notification-list
/organizations/{organizationUuid}/roles:
get:
description: 'Returns a list of all the canonical roles within the organization.
Filterable fields:
* `name`
* `edited_at''
Sortable fields:
* `name`
* `edited_at`
'
operationId: getOrganizationRoles
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/312c0121-906b-4498-8402-7b479172768c
description: Some details about team lead.
flags:
default: true
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: aaaa1234-11e2-c374-6954-6931d150b259
name: Team Lead
organization:
name: Example Organization
uuid: 065f4d9e-efbf-4b0e-8cf6-42fa432baede
permissions:
- 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
uuid: 312c0121-906b-4498-8402-7b479172768c
- _links:
self:
href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/5f7da0a9-9ff0-4db8-802e-9d2b9969efc2
description: Some details about senior developer.
flags:
default: false
last_edited:
edited_at: '2011-03-28T13:09:41-04:00'
user:
first_name: Acquia
last_name: Support
mail: support@acquia.com
picture_url: null
username: support.acquia
uuid: 6661357e-f562-4b77-8de9-60b4bf83e01b
name: Senior Developer
organization:
name: Example Organization
uuid: 065f4d9e-efbf-4b0e-8cf6-42fa432baede
permissions:
- 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: 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
uuid: 5f7da0a9-9ff0-4db8-802e-9d2b9969efc2
- _links:
self:
href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/5f7da0a9-9ff0-4db8-802e-9d2b9969efc2
description: Some details about developer.
flags:
default: false
last_edited:
edited_at: '2011-03-28T13:09:41-04:00'
user:
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: bbbb1234-11e2-c374-6954-6931d150b259
name: Developer
organization:
name: Example Organization
uuid: 065f4d9e-efbf-4b0e-8cf6-42fa432baede
permissions:
- 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
uuid: d33cd9ff-281d-4bcf-9f89-b10b249caa35
_links:
filter:
href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baedc/roles{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baedc/roles{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede
self:
href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles
sort:
href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baedc/roles{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_roles'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Returns a List of All the Canonical Roles Within the Organization.
tags:
- Organizations
x-cli-name: organizations:roles-list
post:
description: Creates a role.
operationId: postOrganizationRoles
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
content:
application/hal+json:
example:
description: My role description
name: My new role
permissions:
- permission 1
- permission 2
schema:
properties:
description:
description: The description of the new role.
maxLength: 255
minLength: 1
type: string
name:
description: The name of the new role to create.
maxLength: 255
minLength: 1
type: string
permissions:
description: An array of permissions to grant to this role.
items:
description: A permission.
type: string
type: array
required:
- name
- permissions
type: object
application/x-www-form-urlencoded:
example:
description: My role description
name: My new role
permissions:
- permission 1
- permission 2
schema:
properties:
description:
description: The description of the new role.
maxLength: 255
minLength: 1
type: string
name:
description: The name of the new role to create.
maxLength: 255
minLength: 1
type: string
permissions:
description: An array of permissions to grant to this role.
items:
description: A permission.
type: string
type: array
required:
- name
- permissions
type: object
required: true
responses:
'200':
content:
application/hal+json:
examples:
Role created:
value:
message: Role created.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: Accepted
'400':
content:
application/hal+json:
examples:
Invalid permission:
value:
error: validation_failed
message:
permissions: The permission 'permission 1' is not a valid permission
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_validation-error'
description: Forbidden
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization you are trying to retrieve 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:
Missing team:
value:
error: conflict
message: An organization must have at least one team in order
to create new roles.
Role already exists:
value:
error: conflict
message: The name for this role is already being used within this
organization.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates a Role.
tags:
- Organizations
x-cli-name: organizations:role-create
/organizations/{organizationUuid}/subscriptions:
get:
description: 'Returns a list of subscriptions that belong to the organization.
Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getOrganizationSubscriptions
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470
flags:
remote_admin: true
hosting:
id: devcloud:devcloud2
type: acp
id: 241643
name: Sample application 1
organization:
name: Sample organization
uuid: d4e44648-8780-4105-905c-43a1eb486481
status: normal
subscription:
name: Sample subscription
uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470
- _links:
self:
href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471
flags:
remote_admin: false
hosting:
id: devcloud:devcloud2
type: free
id: 954291
name: Sample application 2
organization:
name: Sample organization
uuid: d4e44648-8780-4105-905c-43a1eb486481
status: provisioning
subscription:
name: Sample subscription
uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6
tags:
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1
color: blue
name: tag-1
- _links:
parent:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags
self:
href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2
color: green
name: tag-2
type: drupal
uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471
_links:
filter:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?limit}
templated: true
offset:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?offset}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481
self:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications
sort:
href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?sort}
templated: true
pagination:
limit: 10
offset: 0
total: 2
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_applications'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Returns a List of Subscriptions That Belong to the Organization.
tags:
- Organizations
x-cli-name: organizations:subscriptions-list
/organizations/{organizationUuid}/team-invites:
get:
description: 'Gets a list of member invitations for all teams in this organization.
Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getOrganizationTeamInvites
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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/invites/dd9ea69fdcb6bee08b31a858b85535ec
applications: []
author:
created_at: '2014-08-14T17:37:23-04:00'
first_name: Joe
last_login_at: '2019-01-30T08:58:07-05:00'
last_name: Smith
mail: joe.smith@example.com
picture_url: https://accounts.acquia.com/images/users/879fc134-e8d9-49ab-a1a8-ffa33fddf8c9/style/avatar
username: joe.smith
uuid: 879fc134-e8d9-49ab-a1a8-ffa33fddf8c9
created_at: '2012-05-15T12:00:00Z'
email: invitee@example.com
flags:
declined: true
organization:
name: Organization Name
uuid: d72c0cf8-62e2-418d-8530-6e54f122cf96
roles:
- name: Senior Developer
uuid: f540b0ba-d32e-4f48-be78-e932ccb8c201
team:
name: Team Name 1
uuid: c682c830-f67a-4c49-9444-9ef8cec46f43
token: dd9ea69fdcb6bee08b31a858b85535ec
uuid: fd745f4b-178f-4c09-87cc-4061a60eb1c9
- _links:
self:
href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed
applications: []
author:
created_at: '2017-08-14T17:37:23-04:00'
first_name: Jane
last_login_at: '2018-01-30T08:58:07-05:00'
last_name: Smith
mail: jane.smith@example.com
picture_url: https://accounts.acquia.com/images/users/7e181890-bfb9-40d7-874b-ec78912c7525/style/avatar
username: joe.smith
uuid: 7e181890-bfb9-40d7-874b-ec78912c7525
created_at: '2012-05-15T12:00:00Z'
email: invitee2@example.com
flags:
declined: false
organization:
name: Organization Name
uuid: d72c0cf8-62e2-418d-8530-6e54f122cf96
roles:
- name: Senior Developer
uuid: f540b0ba-d32e-4f48-be78-e932ccb8c201
- name: Team Lead
uuid: 84217d35-78df-4d1b-91b5-de165ce6c2e7
team:
name: Team Name 1
uuid: c682c830-f67a-4c49-9444-9ef8cec46f43
token: dd9ea69fdcb6bee08b31a858b85535ed
uuid: 036612d0-8879-44a6-b2e2-93e0e30fc7fb
- _links:
self:
href: https://cloud.acquia.com/api/invites/aa1ea69fdcb6bee08b31a858b85535ee
applications: []
author:
created_at: '2016-03-14T17:37:23-04:00'
first_name: David
last_login_at: '2018-03-21T08:48:07-05:00'
last_name: Green
mail: david.green@example.com
picture_url: https://accounts.acquia.com/images/users/36dd8434-8eda-4c75-9f80-4f8a76d622b2/style/avatar
username: joe.smith
uuid: 36dd8434-8eda-4c75-9f80-4f8a76d622b2
created_at: '2013-05-15T12:00:00Z'
email: invitee2@example.com
flags:
declined: false
organization:
name: Organization Name
uuid: d72c0cf8-62e2-418d-8530-6e54f122cf96
roles:
- name: Senior Developer
uuid: f540b0ba-d32e-4f48-be78-e932ccb8c201
team:
name: Team Name 2
uuid: 16fa24c5-ff65-4e21-902d-58af2aa11b4c
token: aa1ea69fdcb6bee08b31a858b85535ee
uuid: 24f7baea-5d0c-4860-8838-23130f092c48
_links:
filter:
href: https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96/team-invites{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96/team-invites{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96
self:
href: https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96/team-invites
sort:
href: https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96/team-invites{?sort}
templated: true
total: 3
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_organization-team-invites'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Gets a List of Member Invitations for All Teams in This Organization.
tags:
- Organizations
x-cli-name: organizations:team-invite-list
/organizations/{organizationUuid}/teams:
get:
description: 'Returns a list of teams associated with the organization.
Filterable fields:
* `name`
Sortable fields:
* `name`
'
operationId: getOrganizationTeams
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-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/teams/2c9ea556-4016-11e3-9170-12313920a02c
created_at: 2013-10-28T14:16:07-0700
name: Team Name 1
organization:
name: Sample Organization
uuid: 842da900-3488-4139-9f31-656665857267
updated_at: 2015-02-19T08:53:10-0800
uuid: e8a29774-8f46-4765-9529-d564c81ba05f
- _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: 842da900-3488-4139-9f31-656665857267
updated_at: 2015-01-30T05:49:16-0800
uuid: 4b30d7e6-84af-4d80-931a-4172f57fe1b0
_links:
filter:
href: https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc/teams{?filter}
templated: true
limit:
href: https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc/teams{?limit}
templated: true
parent:
href: https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc
self:
href: https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc/teams
sort:
href: https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc/teams{?sort}
templated: true
total: 2
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_teams'
description: OK
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization 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 Returns a List of Teams Associated with the Organization.
tags:
- Organizations
x-cli-name: organizations:team-list
post:
description: Creates a team.
operationId: postOrganizationTeams
parameters:
- $ref: '#/components/parameters/Acquia_Cloud_API_Documentation_organization-uuid'
requestBody:
content:
application/hal+json:
example:
name: My new team
schema:
properties:
name:
description: The name of the new team to create.
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
application/x-www-form-urlencoded:
example:
name: My new team
schema:
properties:
name:
description: The name of the new team to create.
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
required: true
responses:
'200':
content:
application/hal+json:
examples:
Invited:
value:
message: Team created.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_message'
description: OK
'201':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_team'
description: Created
'404':
content:
application/hal+json:
examples:
Not found:
value:
error: not_found
message: The organization you are trying to retrieve 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:
Team name already exists:
value:
error: conflict
message: A team with this name already exists in this organization.
schema:
$ref: '#/components/schemas/Acquia_Cloud_API_Documentation_error'
description: Conflict
security:
- Acquia_Cloud_API_Documentation_OAuth2: []
summary: Acquia Creates a Team.
tags:
- Organizations
x-cli-name: organizations:team-create
servers: []
tags:
- name: Organizations