diff --git a/assets/acquia-spec.yaml b/assets/acquia-spec.yaml index 0b5a2346c..c13d3a092 100644 --- a/assets/acquia-spec.yaml +++ b/assets/acquia-spec.yaml @@ -3,7 +3,7 @@ info: title: Acquia Cloud API Documentation x-logo: url: assets/cloud-platform.svg - backgroundColor: '#FFFFFF' + backgroundColor: "#FFFFFF" altText: Acquia Cloud description: | Acquia Cloud API @@ -36,7 +36,7 @@ info: A specific version of an endpoint can be requested via the `Accept` header: - Accept: application/json, version=2 + Accept: application/hal+json, version=2 If the version is not specified, the latest version of the endpoint will be used. @@ -46,7 +46,7 @@ info: Some endpoints will return a 503 status when dependent services are unavailable: - application/json + application/hal+json { "error": "system", "message": "This action is currently unavailable. Please try again later." @@ -60,13 +60,13 @@ info: ### Example implementation - An example PHP script for making authenticated API requests can be found at https://docs.acquia.com/_downloads/api-v2-auth.php. This script uses the League/oauth2-client library, installed via Composer. + An example PHP script for making authenticated API requests can be found here. This script uses the League/oauth2-client library, installed via Composer. version: 2.0.0 contact: name: Customer Experience Engineering (CXE) - url: 'https://www.acquia.com' + url: https://www.acquia.com servers: - - url: 'https://cloud.acquia.com/api' + - url: https://cloud.acquia.com/api description: Cloud API components: parameters: @@ -122,7 +122,7 @@ components: name: databaseName in: path required: true - description: 'The database name, typically lower snake case.' + description: The database name, typically lower snake case. schema: type: string example: my_db @@ -145,7 +145,7 @@ components: DrushVersion: name: version in: query - description: 'Specifies the drush aliases formatting, either 8 (example.aliases.drushrc.php) or 9 (example.site.yaml)' + description: Specifies the drush aliases formatting, either 8 (example.aliases.drushrc.php) or 9 (example.site.yaml) required: true schema: type: integer @@ -170,7 +170,7 @@ components: type: string minLength: 1 maxLength: 255 - pattern: '^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$' + pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$ example: EXAMPLE_VARIABLE_NAME IndexId: name: indexId @@ -218,7 +218,7 @@ components: description: The internal database identifier of the server. schema: type: string - example: 42 + example: "42" ServerType: name: serverType in: query @@ -276,7 +276,9 @@ components: - varnish-requests - web-cpu - web-memory - example: web-cpu + example: + - web-cpu + - web-memory TagName: name: tagName in: path @@ -299,12 +301,11 @@ components: required: true schema: type: string - example: - - views + example: views UserSearch: name: userSearch in: query - description: 'The user''s username, email, name, or token. This can be a partial match.' + description: The user's username, email, name, or token. This can be a partial match. required: true schema: type: string @@ -444,16 +445,16 @@ components: DeprecatedFrom: name: from in: query - description: '(Use filter `from` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `to` query.' + description: (Use filter `from` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `to` query. deprecated: true required: false schema: type: string - example: '2019-10-01T00:00:00.000Z' + example: 2019-10-01T00:00:00.000Z DeprecatedTo: name: to in: query - description: '(Use filter `to` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `from` query.' + description: (Use filter `to` instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with `from` query. deprecated: true required: false schema: @@ -466,7 +467,7 @@ components: required: false schema: type: string - example: '-7d' + example: -7d FromNoDefault: name: from in: query @@ -490,7 +491,7 @@ components: required: false schema: type: string - example: '-1d' + example: -1d ToNoDefault: name: to in: query @@ -508,7 +509,7 @@ components: schema: type: string minimum: 1 - example: 'field1,-field2' + example: field1,-field2 Filter: name: filter in: query @@ -685,7 +686,7 @@ components: type: string description: The human-friendly confirmation of the creation of the resource. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Pagination: type: object description: A collection of pagination properties. @@ -722,7 +723,7 @@ components: type: boolean description: Whether Acquia Cloud Free provisioning is currently enabled. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" ValidationError: type: object required: @@ -750,7 +751,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of invites matching the request parameters. @@ -758,7 +759,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Invite' + $ref: "#/components/schemas/Invite" Agreement: type: object required: @@ -802,8 +803,9 @@ components: type: string format: date-time description: The date the agreement was last updated. + nullable: true actioned_by: - $ref: '#/components/schemas/UserStub' + $ref: "#/components/schemas/UserStubNullable" reference: type: object description: A reference to the entity for this agreement. @@ -819,7 +821,7 @@ components: type: string description: The entity type. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Agreements: type: object required: @@ -831,7 +833,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of agreements matching the request parameters. @@ -839,7 +841,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Agreement' + $ref: "#/components/schemas/Agreement" Invitees: type: object required: @@ -851,7 +853,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of invitees matching the request parameters. @@ -859,7 +861,7 @@ components: items: type: array items: - $ref: '#/components/schemas/UserStub' + $ref: "#/components/schemas/UserStub" Application: type: object required: @@ -904,16 +906,18 @@ components: type: string description: The hosting ID. subscription: - $ref: '#/components/schemas/SubscriptionStub' + $ref: "#/components/schemas/SubscriptionStub" organization: - $ref: '#/components/schemas/OrganizationStub' + $ref: "#/components/schemas/OrganizationStub" flags: - $ref: '#/components/schemas/ApplicationFlags' + $ref: "#/components/schemas/ApplicationFlags" type: type: string enum: - drupal - node + - static + - node-ssr description: The type of application supported. status: type: string @@ -922,28 +926,26 @@ components: - provisioning description: The current application status. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: Entities related to the application. properties: subscription: - $ref: '#/components/schemas/SubscriptionStubEmbedded' + $ref: "#/components/schemas/SubscriptionStubEmbedded" organization: - $ref: '#/components/schemas/OrganizationStubEmbedded' + $ref: "#/components/schemas/OrganizationStubEmbedded" tags: type: array items: - $ref: '#/components/schemas/ResourceTagEmbedded' + $ref: "#/components/schemas/ResourceTagEmbedded" ApplicationFlags: type: object description: An array of various flags that indicate functionality associated with applications. - additionalProperties: - type: object - properties: - remote_admin: - type: boolean - description: Whether this application has remote administration enabled. + properties: + remote_admin: + type: boolean + description: Whether this application has remote administration enabled. Applications: type: object properties: @@ -951,7 +953,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of applications. @@ -959,7 +961,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Application' + $ref: "#/components/schemas/ApplicationNoEmbedded" ApplicationFeature: type: object required: @@ -983,7 +985,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of application feature flags. @@ -991,7 +993,7 @@ components: items: type: array items: - $ref: '#/components/schemas/ApplicationFeature' + $ref: "#/components/schemas/ApplicationFeature" ApplicationMetadata: type: object description: Application metadata. @@ -1003,6 +1005,70 @@ components: type: string format: uuid description: The application UUID. + ApplicationNoEmbedded: + type: object + required: + - id + - uuid + - name + - hosting + - subscription + - organization + - flags + - type + - status + - _links + properties: + id: + type: integer + description: The unique internal ID of the application. + uuid: + type: string + format: uuid + description: The UUID of the application. + name: + type: string + description: The name of the application. + hosting: + type: object + description: Hosting details for this application. + properties: + type: + type: string + enum: + - ace + - acp + - acsf + - free + - network + - search + - unknown + description: The hosting type. + id: + type: string + description: The hosting ID. + subscription: + $ref: "#/components/schemas/SubscriptionStub" + organization: + $ref: "#/components/schemas/OrganizationStub" + flags: + $ref: "#/components/schemas/ApplicationFlags" + type: + type: string + enum: + - drupal + - node + - static + - node-ssr + description: The type of application supported. + status: + type: string + enum: + - normal + - provisioning + description: The current application status. + _links: + $ref: "#/components/schemas/Links" ApplicationsNotifications: type: object required: @@ -1014,7 +1080,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of notifications matching the request parameters. @@ -1022,7 +1088,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Notification' + $ref: "#/components/schemas/Notification" ApplicationsPermissions: type: object required: @@ -1035,18 +1101,16 @@ components: type: integer description: The number of items returned in the collection. flags: - type: array - description: An array of additional information about the permissions. - items: - type: object - required: - - administrator - properties: - administrator: - type: boolean - description: Whether the current user is able to administrate the application. + type: object + description: Additional information about the permissions. + required: + - administrator + properties: + administrator: + type: boolean + description: Whether the current user is able to administrate the application. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of permissions matching the request parameters. @@ -1054,7 +1118,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Permission' + $ref: "#/components/schemas/Permission" ApplicationStub: type: object required: @@ -1079,7 +1143,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of tasks matching the request parameters. @@ -1087,7 +1151,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" ApplicationsTeams: type: object required: @@ -1099,7 +1163,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of teams matching the request parameters. @@ -1107,7 +1171,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Team' + $ref: "#/components/schemas/Team" ApplicationDatabases: type: object description: Collection of application databases. @@ -1120,7 +1184,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of database names matching the request parameters. @@ -1128,7 +1192,7 @@ components: items: type: array items: - $ref: '#/components/schemas/ApplicationDatabaseName' + $ref: "#/components/schemas/ApplicationDatabaseName" ApplicationDatabaseName: type: object description: Application database name. @@ -1170,7 +1234,7 @@ components: format: date-time description: The time at which the artifact was created. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Artifacts: type: object properties: @@ -1178,7 +1242,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of artifacts. @@ -1186,7 +1250,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Artifact' + $ref: "#/components/schemas/Artifact" Code: type: object properties: @@ -1194,7 +1258,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of branch and tag information. @@ -1211,15 +1275,13 @@ components: type: string description: The name of the branch or tag. flags: - $ref: '#/components/schemas/CodeFlags' + $ref: "#/components/schemas/CodeFlags" CodeFlags: type: object description: An array of various flags that indicate functionality associated with code branches and tags on applications. - additionalProperties: - type: object - properties: - tag: - type: boolean + properties: + tag: + type: boolean ResourceTag: type: object required: @@ -1261,7 +1323,7 @@ components: format: uuid description: The application UUID. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" ResourceTagEmbedded: type: object description: An associated tag. @@ -1277,7 +1339,46 @@ components: type: string description: The color of the tag. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" + ResourceTagOrganization: + type: object + required: + - name + - color + - context + properties: + name: + type: string + description: The name of the tag. + color: + type: string + description: The color of the tag. + context: + type: object + description: Metadata related to the tag. + properties: + organization: + type: object + description: A collection of organization metadata for the tag. + properties: + uuids: + type: array + description: An array of organization UUIDs. + items: + type: string + format: uuid + description: The organization UUID. + application: + type: object + description: A collection of application metadata for the tag. + properties: + uuids: + type: array + description: An array of application UUIDs. + items: + type: string + format: uuid + description: The application UUID. ResourceTags: type: object required: @@ -1289,7 +1390,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of tags matching the request parameters. @@ -1297,199 +1398,399 @@ components: items: type: array items: - $ref: '#/components/schemas/ResourceTag' - DomainRegistration: + $ref: "#/components/schemas/ResourceTag" + CodeStudioApplication: type: object + description: The model for a Code Studio application. required: - uuid - - domain_name - - health - - dns_records + - name - _links - description: The Domain Registration. + - _embedded properties: uuid: type: string format: uuid - description: The UUID of the domain registration. - domain_name: - type: string - format: uri - description: The domain name. - health: - $ref: '#/components/schemas/Health' - dns_records: - $ref: '#/components/schemas/DomainRegistrationDnsRecords' - _links: - $ref: '#/components/schemas/Links' - DomainRegistrations: - type: object - properties: - total: - type: integer - description: The number of items returned in the collection. - pagination: - $ref: '#/components/schemas/Pagination' - _links: - $ref: '#/components/schemas/Links' - _embedded: - type: object - description: A collection of domain registrations. - properties: - items: - type: array - items: - $ref: '#/components/schemas/DomainRegistration' - DomainRegistrationDnsRecord: - type: object - description: A DNS record. - required: - - type - - value - properties: - type: - type: string - description: The type of DNS record. - enum: - - TXT - - MX - - CNAME + description: The unique identifier of the application. name: type: string - description: The name of the DNS record - value: - type: string - description: The DNS record value. - health: - $ref: '#/components/schemas/Health' - DomainRegistrationDnsRecords: - type: object - properties: - total: - type: integer - description: The number of items returned in the collection. + description: The application name. _links: - $ref: '#/components/schemas/Links' - _embedded: - type: object - description: A collection of DNS records - properties: - items: - type: array - items: - $ref: '#/components/schemas/DomainRegistrationDnsRecord' - Distribution: - type: object - required: - - name - - urls - - update_urls - - title - - version - - drupal_version - - description - - image_url - - flags - - _links - properties: - name: - type: string - description: The name of the distribution. - urls: type: object - description: The URLs for the distribution. + description: Links to Code Studio project and API. properties: - gz: - type: object - description: A link to a gzip compressed distribution. - properties: - href: - type: string - description: The URI for the gzip compressed distribution. - zip: + self: type: object - description: A link to a zip compressed distribution. + description: A link to this page. + required: + - href properties: href: type: string - description: The URI for the zip compressed distribution. - update_urls: - type: object - description: The update URLs for the distribution. - properties: - gz: + format: uri + description: The URI for this page. + project: type: object - description: A link to a gzip compressed update. + description: A link to code studio project. + required: + - href properties: href: type: string - description: The URI for the gzip compressed update. - zip: + format: uri + description: The URI for the code studio project. + parent: type: object - description: A link to a zip compressed update. + description: A link to the parent page. + required: + - href properties: href: type: string - description: The URI for the zip compressed update. - title: - type: string - description: The title of the distribution. - version: - type: string - description: The full version string of the distribution. - drupal_version: - type: string - description: The Drupal version string of the distribution. - description: - type: string - description: The verbose description of the distribution. - image_url: - type: object - description: The logo image url for this distribution. - properties: - href: - type: string - description: The URI for the logo image for this distribution. - flags: + format: uri + description: The URI for the parent page. + _embedded: type: object - description: Flags for this distribution. + description: An associated code studio project. properties: - default: - type: boolean - description: Whether this distribution is the default. - _links: - $ref: '#/components/schemas/Links' - Distributions: + project: + $ref: "#/components/schemas/CodeStudioProjectNoEmbedded" + CodeStudioApplications: type: object + description: A collection of applications with associated Code Studio projects for a subscription. + required: + - total + - pagination + - _links + - _embedded properties: total: type: integer description: The number of items returned in the collection. + pagination: + $ref: "#/components/schemas/Pagination" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object - description: A collection of distributions. + description: A collection of Code Studio enabled applications. properties: items: type: array items: - $ref: '#/components/schemas/Distribution' - Email: + $ref: "#/components/schemas/CodeStudioApplication" + CodeStudioOptions: + type: object + description: Code Studio options. + properties: + _links: + $ref: "#/components/schemas/Links" + roles: + type: object + additionalProperties: + type: string + CodeStudioProject: type: object + description: The model for a Code Studio project. required: + - application_id - status + - _embedded - _links - description: The Email status. properties: + application_id: + type: string + format: uuid + description: The associated application id. status: type: string - description: The status of Platform Email for the environment + description: The status of the GitLab project enum: - active - inactive - _links: - $ref: '#/components/schemas/Links' + - installing + - install-failed + - deleted + - deleting + - delete-failed + _embedded: + type: object + description: Contains the embedded Acquia Cloud user. + properties: + application: + $ref: "#/components/schemas/ApplicationStub" + _links: + $ref: "#/components/schemas/Links" + CodeStudioProjectNoEmbedded: + type: object + description: The model for a Code Studio project. + required: + - application_id + - status + - _links + properties: + application_id: + type: string + format: uuid + description: The associated application id. + status: + type: string + description: The status of the GitLab project + enum: + - active + - inactive + - installing + - install-failed + - deleted + - deleting + - delete-failed + _links: + $ref: "#/components/schemas/Links" + CodeStudioSubscriptionMetadata: + type: object + description: The Code Studio status for a subscription. + required: + - status + properties: + status: + type: string + description: A status indicating whether Code Studio has been enabled for the subscription. + enum: + - active + - installing + - install-failed + - deleted + - deleting + - delete-failed + CodeStudioUser: + type: object + description: The model for a Code Studio user. + required: + - uuid + - first_name + - last_name + - mail + - role + - _links + properties: + uuid: + type: string + format: uuid + description: The Acquia Cloud user UUID. + first_name: + type: string + description: The user's first name. + last_name: + type: string + description: The user's last name. + mail: + type: string + format: email + description: The user's email address. + role: + type: string + format: uuid + description: The GitLab role for the user. + _links: + $ref: "#/components/schemas/Links" + CodeStudioUsers: + type: object + description: A collection of users for a subscription with assigned seats for Code Studio. + properties: + total: + type: integer + description: The number of items returned in the collection. + pagination: + $ref: "#/components/schemas/Pagination" + _links: + $ref: "#/components/schemas/Links" + _embedded: + type: object + description: A collection of Code Studio enabled users. + properties: + items: + type: array + items: + $ref: "#/components/schemas/CodeStudioUser" + DomainRegistration: + type: object + required: + - uuid + - domain_name + - health + - dns_records + - _links + description: The Domain Registration. + properties: + uuid: + type: string + format: uuid + description: The UUID of the domain registration. + domain_name: + type: string + format: hostname + description: The domain name. + health: + $ref: "#/components/schemas/Health" + dns_records: + type: array + items: + $ref: "#/components/schemas/DomainRegistrationDnsRecords" + _links: + $ref: "#/components/schemas/Links" + DomainRegistrations: + type: object + properties: + total: + type: integer + description: The number of items returned in the collection. + pagination: + $ref: "#/components/schemas/Pagination" + _links: + $ref: "#/components/schemas/Links" + _embedded: + type: object + description: A collection of domain registrations. + properties: + items: + type: array + items: + $ref: "#/components/schemas/DomainRegistration" + DomainRegistrationDnsRecord: + type: object + description: A DNS record. + required: + - type + - value + properties: + type: + type: string + description: The type of DNS record. + enum: + - TXT + - MX + - CNAME + name: + type: string + description: The name of the DNS record + value: + type: string + description: The DNS record value. + health: + $ref: "#/components/schemas/Health" + DomainRegistrationDnsRecords: + type: object + properties: + total: + type: integer + description: The number of items returned in the collection. + _links: + $ref: "#/components/schemas/Links" + _embedded: + type: object + description: A collection of DNS records + properties: + items: + type: array + items: + $ref: "#/components/schemas/DomainRegistrationDnsRecord" + Distribution: + type: object + required: + - name + - urls + - update_urls + - title + - version + - drupal_version + - description + - image_url + - flags + - _links + properties: + name: + type: string + description: The name of the distribution. + urls: + type: object + description: The URLs for the distribution. + properties: + gz: + type: string + description: The URI for the gzip compressed distribution. + format: uri + zip: + type: string + description: The URI for the zip compressed distribution. + format: uri + update_urls: + type: object + description: The update URLs for the distribution. + properties: + gz: + type: string + description: The URI for the gzip compressed update. + format: uri + zip: + type: string + description: The URI for the zip compressed update. + format: uri + title: + type: string + description: The title of the distribution. + version: + type: string + description: The full version string of the distribution. + drupal_version: + type: string + description: The Drupal version string of the distribution. + description: + type: string + description: The verbose description of the distribution. + image_url: + type: string + description: The URI for the logo image for this distribution. + format: uri + flags: + type: object + description: Flags for this distribution. + properties: + default: + type: boolean + description: Whether this distribution is the default. + _links: + $ref: "#/components/schemas/Links" + Distributions: + type: object + properties: + total: + type: integer + description: The number of items returned in the collection. + _links: + $ref: "#/components/schemas/Links" + _embedded: + type: object + description: A collection of distributions. + properties: + items: + type: array + items: + $ref: "#/components/schemas/Distribution" + Email: + type: object + required: + - status + - _links + description: The Email status. + properties: + status: + type: string + description: The status of Platform Email for the environment + enum: + - active + - inactive + _links: + $ref: "#/components/schemas/Links" EmailDomain: type: object required: @@ -1505,7 +1806,7 @@ components: description: The UUID of the email domain. domain_name: type: string - format: uri + format: hostname description: The domain name. flags: type: object @@ -1515,7 +1816,7 @@ components: type: boolean description: Whether or not Platform Email has been associated with the application. health: - $ref: '#/components/schemas/Health' + $ref: "#/components/schemas/Health" EmailDomains: type: object properties: @@ -1523,9 +1824,9 @@ components: type: integer description: The number of items returned in the collection. pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of email domains. @@ -1533,13 +1834,13 @@ components: items: type: array items: - $ref: '#/components/schemas/EmailDomain' + $ref: "#/components/schemas/EmailDomain" Entitlements: type: object description: Entitlements collection. properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of entitlements. @@ -1548,35 +1849,67 @@ components: type: array items: anyOf: - - $ref: '#/components/schemas/EntitlementPipelines' - - $ref: '#/components/schemas/EntitlementCde' - - $ref: '#/components/schemas/EntitlementConsumptionBasedPricing' - - $ref: '#/components/schemas/EntitlementLogForwarding' - - $ref: '#/components/schemas/EntitlementShield' - - $ref: '#/components/schemas/EntitlementDefaultNewRelic' - - $ref: '#/components/schemas/EntitlementMigrate' + - $ref: "#/components/schemas/EntitlementPipelines" + - $ref: "#/components/schemas/EntitlementCde" + - $ref: "#/components/schemas/EntitlementConsumptionBasedPricing" + - $ref: "#/components/schemas/EntitlementLogForwarding" + - $ref: "#/components/schemas/EntitlementShield" + - $ref: "#/components/schemas/EntitlementDefaultNewRelic" + - $ref: "#/components/schemas/EntitlementMigrate" EntitlementPipelines: type: object description: Pipelines entitlement. required: - name + - offering_ids + - expires_at + - flags properties: name: type: string description: The name of the entitlement. + offering_ids: + type: array + description: The offering IDs associated with the entitlement. + expires_at: + type: string + description: The furthest expiration date. + flags: + type: object + description: The flags associated with the entitlement. + properties: + trial: + type: boolean + description: Determines if the entitlement is a trial. EntitlementCde: type: object description: Continuous delivery environment entitlement. required: - name + - offering_ids + - expires_at + - flags - properties properties: name: type: string description: The name of the entitlement. - properties: + offering_ids: + type: array + description: The offering IDs associated with the entitlement. + expires_at: + type: string + description: The furthest expiration date. + flags: type: object - description: Entitlement data. + description: The flags associated with the entitlement. + properties: + trial: + type: boolean + description: Determines if the entitlement is a trial. + properties: + type: object + description: Entitlement data. properties: databases_total: type: integer @@ -1592,11 +1925,27 @@ components: description: Consumption based pricing entitlement. required: - name + - offering_ids + - expires_at + - flags - properties properties: name: type: string description: The name of the entitlement. + offering_ids: + type: array + description: The offering IDs associated with the entitlement. + expires_at: + type: string + description: The furthest expiration date. + flags: + type: object + description: The flags associated with the entitlement. + properties: + trial: + type: boolean + description: Determines if the entitlement is a trial. properties: type: object description: Entitlement data. @@ -1612,20 +1961,52 @@ components: description: Log forwarding entitlement. required: - name + - offering_ids + - expires_at + - flags properties: name: type: string description: The name of the entitlement. + offering_ids: + type: array + description: The offering IDs associated with the entitlement. + expires_at: + type: string + description: The furthest expiration date. + flags: + type: object + description: The flags associated with the entitlement. + properties: + trial: + type: boolean + description: Determines if the entitlement is a trial. EntitlementMigrate: type: object description: Acquia Migrate Accelerator entitlement. required: - name + - offering_ids + - expires_at + - flags - properties properties: name: type: string description: The name of the entitlement. + offering_ids: + type: array + description: The offering IDs associated with the entitlement. + expires_at: + type: string + description: The furthest expiration date. + flags: + type: object + description: The flags associated with the entitlement. + properties: + trial: + type: boolean + description: Determines if the entitlement is a trial. properties: type: object description: Entitlement data. @@ -1634,11 +2015,27 @@ components: description: Represents the default New Relic account. The default New Relic account is created when a subscription is provisioned. required: - name + - offering_ids + - expires_at + - flags - properties properties: name: type: string description: The name of the entitlement. + offering_ids: + type: array + description: The offering IDs associated with the entitlement. + expires_at: + type: string + description: The furthest expiration date. + flags: + type: object + description: The flags associated with the entitlement. + properties: + trial: + type: boolean + description: Determines if the entitlement is a trial. properties: type: object description: Entitlement data. @@ -1656,10 +2053,26 @@ components: description: Shield entitlement. required: - name + - offering_ids + - expires_at + - flags properties: name: type: string description: The name of the entitlement. + offering_ids: + type: array + description: The offering IDs associated with the entitlement. + expires_at: + type: string + description: The furthest expiration date. + flags: + type: object + description: The flags associated with the entitlement. + properties: + trial: + type: boolean + description: Determines if the entitlement is a trial. Apm: type: object description: Details application performance monitor settings. @@ -1688,7 +2101,7 @@ components: type: boolean description: Whether or not the APM is enabled. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: Entities related to the APM settings. @@ -1700,9 +2113,10 @@ components: type: object properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" ArtifactStub: type: object + nullable: true required: - name - id @@ -1711,7 +2125,7 @@ components: type: string description: The name of the artifact. id: - type: string + type: integer format: id description: The artifact identifier. AvailableRuntimes: @@ -1728,10 +2142,12 @@ components: - php - node versions: - type: string + type: array description: The available versions for this runtime. + items: + type: string _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Backup: type: object description: Response schema for a database backup. @@ -1750,7 +2166,7 @@ components: type: integer description: The ID of the database backup. database: - $ref: '#/components/schemas/DatabaseStub' + $ref: "#/components/schemas/DatabaseStub" type: type: string description: The type of backup this is. @@ -1763,11 +2179,11 @@ components: format: date-time description: The ISO-8601 formatted date/time of when the backup process was completed. flags: - $ref: '#/components/schemas/BackupFlags' + $ref: "#/components/schemas/BackupFlags" environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: Related entities. @@ -1783,7 +2199,7 @@ components: type: string description: The environment name. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" database: type: object description: The related database. @@ -1795,7 +2211,42 @@ components: type: string description: The database name. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" + BackupNoEmbedded: + type: object + description: Response schema for a database backup. + required: + - id + - database + - type + - started_at + - completed_at + - flags + - environment + - _links + properties: + id: + type: integer + description: The ID of the database backup. + database: + $ref: "#/components/schemas/DatabaseStub" + type: + type: string + description: The type of backup this is. + started_at: + type: string + format: date-time + description: The ISO-8601 formatted date/time of when the backup process was started. + completed_at: + type: string + format: date-time + description: The ISO-8601 formatted date/time of when the backup process was completed. + flags: + $ref: "#/components/schemas/BackupFlags" + environment: + $ref: "#/components/schemas/EnvironmentStub" + _links: + $ref: "#/components/schemas/Links" Backups: type: object description: A collection of database backups. @@ -1808,7 +2259,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of database backups matching the request parameters. @@ -1816,7 +2267,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Backup' + $ref: "#/components/schemas/BackupNoEmbedded" BackupFlags: type: object description: Response schema for database backup flags. @@ -1842,11 +2293,11 @@ components: - install-failed - installing _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" CdnInformation: type: object nullable: true - description: 'Domain-specific CDN information, if CDN is enabled.' + description: Domain-specific CDN information, if CDN is enabled. properties: status: type: string @@ -1878,6 +2329,7 @@ components: label: type: string description: The certificate label (SNI only). + nullable: true certificate: type: string description: Returns the PEM encoded certificate. @@ -1888,7 +2340,7 @@ components: type: string description: The CA intermediary chain. flags: - $ref: '#/components/schemas/CertificateFlags' + $ref: "#/components/schemas/CertificateFlags" expires_at: type: string format: date-time @@ -1898,26 +2350,23 @@ components: description: The domain names that this certificate is covering. items: type: string - format: uri environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" CertificateFlags: type: object description: An array of various flags that indicate functionality associated with the certificate. - additionalProperties: - type: object - properties: - active: - type: boolean - description: Whether this certificate is installed/deployed. - csr: - type: boolean - description: Whether this certificate has an associated CSR. - legacy: - type: boolean - description: Whether this is a legacy certificate (ELB). + properties: + active: + type: boolean + description: Whether this certificate is installed/deployed. + csr: + type: boolean + description: Whether this certificate has an associated CSR. + legacy: + type: boolean + description: Whether this is a legacy certificate (ELB). Certificates: type: object description: A collection of certificates. @@ -1926,7 +2375,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of certificates. @@ -1934,7 +2383,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Certificate' + $ref: "#/components/schemas/Certificate" CertificateSigningRequest: type: object description: A certificate signing request. @@ -1980,31 +2429,45 @@ components: common_name: type: string description: The common name (host and domain name). - format: uri alternate_names: type: array description: The subject alternate names (sni only). items: type: string - format: uri + format: hostname flags: - $ref: '#/components/schemas/CertificateSigningRequestFlags' + $ref: "#/components/schemas/CertificateSigningRequestFlags" environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" CertificateSigningRequestFlags: type: object description: An array of various flags that indicate functionality associated with the CSR. - additionalProperties: - type: object - properties: - used: - type: boolean - description: Whether this CSR has already been used for a certificate. - legacy: - type: boolean - description: Whether this is a legacy CSR (meant for use with ELB certificates). + properties: + used: + type: boolean + description: Whether this CSR has already been used for a certificate. + legacy: + type: boolean + description: Whether this is a legacy CSR (meant for use with ELB certificates). + CertificateSigningRequests: + type: object + description: A collection of csrs. + properties: + total: + type: integer + description: The number of items returned in the collection. + _links: + $ref: "#/components/schemas/Links" + _embedded: + type: object + description: A collection of CSRs. + properties: + items: + type: array + items: + $ref: "#/components/schemas/CertificateSigningRequest" CloudAction: type: object required: @@ -2029,9 +2492,9 @@ components: type: string description: The type of Cloud Action. flags: - $ref: '#/components/schemas/CloudActionsFlags' + $ref: "#/components/schemas/CloudActionsFlags" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" CloudActions: type: object properties: @@ -2039,7 +2502,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of Cloud Actions. @@ -2047,7 +2510,7 @@ components: items: type: array items: - $ref: '#/components/schemas/CloudAction' + $ref: "#/components/schemas/CloudAction" CloudActionsFlags: type: object description: Various flags for the Cloud Action. @@ -2083,7 +2546,7 @@ components: format: uuid description: The ID of the cron job. server: - $ref: '#/components/schemas/ServerStub' + $ref: "#/components/schemas/ServerStub" command: type: string description: The cron command. @@ -2106,26 +2569,24 @@ components: type: string description: The label for the cron. flags: - $ref: '#/components/schemas/CronFlags' + $ref: "#/components/schemas/CronFlags" environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" CronFlags: type: object description: An array of various flags that indicate functionality associated with cron jobs. - additionalProperties: - type: object - properties: - enabled: - type: boolean - description: Whether this this cron is enabled. - system: - type: boolean - description: 'Whether this is a system cron, which cannot be modified.' - on_any_web: - type: boolean - description: Whether this cron will run on the lowest numbered web. + properties: + enabled: + type: boolean + description: Whether this this cron is enabled. + system: + type: boolean + description: Whether this is a system cron, which cannot be modified. + on_any_web: + type: boolean + description: Whether this cron will run on the lowest numbered web. Crons: type: object properties: @@ -2133,7 +2594,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of cron jobs. @@ -2141,7 +2602,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Cron' + $ref: "#/components/schemas/Cron" Database: type: object description: Response schema for a database. @@ -2175,18 +2636,18 @@ components: description: The connection URL. db_host: type: string - format: uri - description: 'The server the database lives on, relative to the SSH host.' + format: hostname + description: The server the database lives on, relative to the SSH host. ssh_host: type: string - format: uri - description: 'The server to SSH to, in order to access the database on the CLI.' + format: hostname + description: The server to SSH to, in order to access the database on the CLI. flags: - $ref: '#/components/schemas/DatabaseFlags' + $ref: "#/components/schemas/DatabaseFlags" environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Databases: type: object description: A collection of databases. @@ -2199,7 +2660,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of databases matching the request parameters. @@ -2207,7 +2668,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Database' + $ref: "#/components/schemas/Database" DatabaseFlags: type: object description: Response schema for database flags. @@ -2229,7 +2690,7 @@ components: type: string description: The Drupal PHP configuration settings file content. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" DatabaseStub: type: object description: Schema for a stub of information regarding a database. @@ -2258,13 +2719,13 @@ components: type: array description: Environment apex domain DNS records. items: - $ref: '#/components/schemas/DnsRecord' + $ref: "#/components/schemas/DnsRecord" subdomains: deprecated: true type: array description: Environment subdomain DNS records. items: - $ref: '#/components/schemas/DnsRecord' + $ref: "#/components/schemas/DnsRecord" regional_configuration: type: object description: List of regional apex and subdomain DNS records. @@ -2273,12 +2734,12 @@ components: type: array description: Environment regional apex domain DNS records. items: - $ref: '#/components/schemas/DnsRecord' + $ref: "#/components/schemas/DnsRecord" subdomains: type: array description: Environment regional subdomain DNS records. items: - $ref: '#/components/schemas/DnsRecord' + $ref: "#/components/schemas/DnsRecord" global_configuration: type: object description: List of global apex and subdomain DNS records. @@ -2287,14 +2748,14 @@ components: type: array description: Environment global apex domain DNS records. items: - $ref: '#/components/schemas/DnsRecord' + $ref: "#/components/schemas/DnsRecord" subdomains: type: array description: Environment global subdomain DNS records. items: - $ref: '#/components/schemas/DnsRecord' + $ref: "#/components/schemas/DnsRecord" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" DnsRecord: type: object description: A DNS record. @@ -2324,16 +2785,15 @@ components: properties: hostname: type: string - format: uri description: The domain's hostname. cdn: - $ref: '#/components/schemas/CdnInformation' + $ref: "#/components/schemas/CdnInformation" flags: - $ref: '#/components/schemas/DomainFlags' + $ref: "#/components/schemas/DomainFlags" environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Domains: type: object description: A collection of domains. @@ -2346,7 +2806,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of domains matching the request parameters. @@ -2354,7 +2814,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Domain' + $ref: "#/components/schemas/Domain" DomainFlags: type: object required: @@ -2386,9 +2846,8 @@ components: hostname: type: string description: The domain hostname. - format: uri flags: - $ref: '#/components/schemas/DomainStatusFlags' + $ref: "#/components/schemas/DomainStatusFlags" ip_addresses: type: array description: An array of this domain's IP addresses. @@ -2400,11 +2859,10 @@ components: description: An array of this domain's cnames. items: type: string - format: uri environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" DomainStatusFlags: type: object description: An array of hosting flags for the domain. @@ -2442,7 +2900,7 @@ components: type: string description: The IPv6 address. flags: - $ref: '#/components/schemas/EIPFlags' + $ref: "#/components/schemas/EIPFlags" EIPFlags: type: object description: Various flags for the Web EIP. @@ -2465,7 +2923,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of Web EIPs. @@ -2473,7 +2931,7 @@ components: items: type: array items: - $ref: '#/components/schemas/EIP' + $ref: "#/components/schemas/EIP" Environment: type: object required: @@ -2510,25 +2968,26 @@ components: type: string description: The stage name of the environment. application: - $ref: '#/components/schemas/ApplicationStub' + $ref: "#/components/schemas/ApplicationStub" domains: type: array description: An array of domain names attached to this environment. items: type: string - format: uri + format: hostname active_domain: type: string - format: uri + format: hostname description: The active domain name for this environment. default_domain: type: string - format: uri + format: hostname description: The default domain name for this environment. image_url: type: string format: uri description: The URL to the image for this environment. + nullable: true ssh_url: type: string description: The URL used to SSH into the environment. @@ -2581,6 +3040,7 @@ components: size: type: string description: The size of the environment. Will be null if the environment type does not support sizes. + nullable: true enum: - small - medium @@ -2588,24 +3048,26 @@ components: - unknown weight: type: integer + nullable: true description: The environment weight for display purposes. vcs: - $ref: '#/components/schemas/Vcs' + $ref: "#/components/schemas/Vcs" flags: - $ref: '#/components/schemas/EnvironmentFlags' + $ref: "#/components/schemas/EnvironmentFlags" configuration: type: object description: A collection of environment configuration information. + nullable: true properties: operation_system: type: string description: The environment operation system. php: - $ref: '#/components/schemas/EnvironmentConfigurations' + $ref: "#/components/schemas/EnvironmentConfigurations" artifact: - $ref: '#/components/schemas/ArtifactStub' + $ref: "#/components/schemas/ArtifactStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" EnvironmentConfigurations: type: object description: An array of configuration details for the environment. @@ -2619,99 +3081,105 @@ components: default: 128 minimum: 128 maximum: 1024 + nullable: true opcache: type: integer description: This is the total amount of memory available for caching precompiled script bytecode per PHP/FPM process. default: 96 minimum: 96 maximum: 512 + nullable: true apcu: type: integer description: APCu shared memory size per web server. default: 32 minimum: 32 maximum: 512 + nullable: true interned_strings_buffer: type: integer description: Sets PHP Opcache key count per server. default: 8 minimum: 8 maximum: 32 + nullable: true max_execution_time: type: integer description: Limits PHP request time in seconds. default: 300 minimum: 1 maximum: 300 + nullable: true max_post_size: type: integer description: Sets the PHP limit on POST body size. default: 256 minimum: 64 maximum: 1024 + nullable: true max_input_vars: type: integer description: Limits the number of various request items in PHP. default: 1000 minimum: 500 maximum: 20000 + nullable: true memcached_limit: type: integer description: Sets the maximum amount of memory in MB that can be allocated to memcached. Only available on Acquia Cloud Next. default: 64 minimum: 0 maximum: 12288 + nullable: true EnvironmentFlags: type: object description: An array of various flags that indicate functionality associated with the environment. - additionalProperties: - type: object - properties: - cde: - type: boolean - description: Determines if the environment is on-demand. - cdn: - type: boolean - description: Determines if the environment has Platform CDN enabled. - cloud-actions: - type: boolean - description: Determines if the environment has Cloud Actions enabled. - eips: - type: boolean - description: Determines if the environment has Web EIPs enabled. - email: - type: boolean - description: Determines if the environment has Platform Email enabled. - hsd: - type: boolean - description: Determines if the environment is under high-site density. - livedev: - type: boolean - description: Determines if the environment has live development enabled. - migration: - type: boolean - description: Determines if the environment is a Migrate Environment. - multicert: - type: boolean - description: Determines if the environment has multicert enabled. - multi_region: - type: boolean - description: Whether or not the environment is multi-regioned. - production: - type: boolean - description: Determines if the environment is production. - production_mode: - type: boolean - description: Determines if the environment has production mode enabled. - remote_admin: - type: boolean - description: Determines if the environment is a remote administration environment. - varnish: - type: boolean - description: Determines if the environment has Varnish. - varnish_over_ssl: - type: boolean - description: Determines if the environment is configured for varnish over SSL. + properties: + cde: + type: boolean + description: Determines if the environment is on-demand. + cdn: + type: boolean + description: Determines if the environment has Platform CDN enabled. + cloud-actions: + type: boolean + description: Determines if the environment has Cloud Actions enabled. + eips: + type: boolean + description: Determines if the environment has Web EIPs enabled. + email: + type: boolean + description: Determines if the environment has Platform Email enabled. + hsd: + type: boolean + description: Determines if the environment is under high-site density. + livedev: + type: boolean + description: Determines if the environment has live development enabled. + migration: + type: boolean + description: Determines if the environment is a Migrate Environment. + multicert: + type: boolean + description: Determines if the environment has multicert enabled. + multi_region: + type: boolean + description: Whether or not the environment is multi-regioned. + production: + type: boolean + description: Determines if the environment is production. + production_mode: + type: boolean + description: Determines if the environment has production mode enabled. + remote_admin: + type: boolean + description: Determines if the environment is a remote administration environment. + varnish: + type: boolean + description: Determines if the environment has Varnish. + varnish_over_ssl: + type: boolean + description: Determines if the environment is configured for varnish over SSL. EnvironmentMetadata: type: object description: Environment metadata. @@ -2732,7 +3200,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of environments matching the request parameters. @@ -2740,7 +3208,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Environment' + $ref: "#/components/schemas/Environment" EnvironmentSettings: type: object description: A collection of links to environment settings. @@ -2748,7 +3216,7 @@ components: - _links properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" EnvironmentStub: type: object description: Schema for a stub of information regarding an environment. @@ -2775,14 +3243,14 @@ components: description: The name of the variable. minLength: 1 maxLength: 255 - pattern: '^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$' + pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$ value: type: string description: The value of the variable. minLength: 0 maxLength: 5000 _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" EnvironmentVariables: type: object required: @@ -2795,7 +3263,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of variables matching the request parameters. @@ -2803,7 +3271,7 @@ components: items: type: array items: - $ref: '#/components/schemas/EnvironmentVariable' + $ref: "#/components/schemas/EnvironmentVariable" FileDownload: type: object description: A JSON response containing the url and url expiration. @@ -2840,7 +3308,17 @@ components: type: boolean description: Whether or not this log file is available. _links: - $ref: '#/components/schemas/Links' + type: object + description: Links associated with the logfile. + properties: + download: + type: object + description: Download data for the logfile. + properties: + href: + type: string + format: uri + description: The download link for the logfile. Logs: type: object description: A collection of logs. @@ -2853,7 +3331,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of logs matching the request parameters. @@ -2861,7 +3339,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Log' + $ref: "#/components/schemas/Log" Logstream: type: object description: Connection details for Logstream backend. @@ -2883,14 +3361,14 @@ components: description: WebSocket URL. params: type: object - description: 'Connection details such as a timestamp, hmac, site name and environment.' + description: Connection details such as a timestamp, hmac, site name and environment. commands: type: array description: Commands for the logstream backend. items: type: string _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" LogForwardingDestination: type: object required: @@ -2915,17 +3393,20 @@ components: type: string description: The human-friendly identifier of the destination. sources: - type: string + type: array description: The list of log sources to forward. - enum: - - apache-access - - apache-error - - varnish-access - - drupal-request - - drupal-watchdog - - php-error - - stdout - - stderr + items: + type: string + description: A log source. + enum: + - apache-access + - apache-error + - varnish-access + - drupal-request + - drupal-watchdog + - php-error + - stdout + - stderr consumer: type: string description: The application or provider consuming the logs. @@ -2935,10 +3416,9 @@ components: - sumologic - syslog credentials: - $ref: '#/components/schemas/LogForwardingDestinationCredentials' + $ref: "#/components/schemas/LogForwardingDestinationCredentials" address: type: string - format: uri description: The URL or host name and port of the destination. status: type: string @@ -2955,13 +3435,13 @@ components: - inactive - failing flags: - $ref: '#/components/schemas/LogForwardingDestinationFlags' + $ref: "#/components/schemas/LogForwardingDestinationFlags" health: - $ref: '#/components/schemas/Health' + $ref: "#/components/schemas/Health" environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" LogForwardingDestinations: type: object required: @@ -2974,7 +3454,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of log forwarding destinations matching the request parameters. @@ -2982,25 +3462,32 @@ components: items: type: array items: - $ref: '#/components/schemas/LogForwardingDestination' + $ref: "#/components/schemas/LogForwardingDestination" LogForwardingDestinationCredentials: type: object required: - certificate - - key - - expires_at description: The Log Forwarding destination credentials. properties: certificate: - type: string - description: 'A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly.' + type: object + description: A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly. + properties: + certificate: + type: string + description: A public X.509 certificate in PEM format. + expires_at: + type: string + format: date-time + description: The ISO-8601 date the certificate will expire at. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk. key: type: string - description: 'The certificate private key, in PEM format, used to encrypt the log traffic. Optional for Splunk, Sumologic, and Syslog. Not supported by Loggly' - expires_at: + description: The certificate private key, in PEM format, used to encrypt the log traffic. Optional for Splunk, Sumologic, and Syslog. Not supported by Loggly. + nullable: true + token: type: string - format: date-time - description: The ISO-8601 date the certificate will expire at. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk. + description: An API token associated with the consumer. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk. + nullable: true LogForwardingDestinationFlags: type: object description: Various flags for this log forwarding destination. @@ -3076,7 +3563,7 @@ components: type: string description: The organization name for CSR generation. organizational_unit: - type: integer + type: string description: The organizational unit (department) for CSR generation. common_name: type: string @@ -3086,7 +3573,7 @@ components: type: array items: type: string - format: uri + format: hostname PutCloudActions: type: object description: A Cloud Action or a series of Cloud Actions paired with enable or disable boolean value. @@ -3130,11 +3617,9 @@ components: - core_contrib pause_until: type: string - format: date-time description: What date/time to pause RA updates until (if applicable). deploy_at: type: string - format: date-time description: What date/time to deploy RA updates at (if applicable). deploy_environment: type: string @@ -3163,13 +3648,13 @@ components: - _links properties: balancer: - type: string + type: object description: SSL configuration for the load balancer associated with this environment. properties: hostname: type: string description: The balancer CNAME. - format: uri + format: hostname ips: type: array description: The IP addresses for the environment. @@ -3177,7 +3662,7 @@ components: type: string format: ipv4 _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Vcs: type: object required: @@ -3194,10 +3679,10 @@ components: path: type: string description: The path or branch name. + nullable: true url: type: string description: The VCS url. - format: uri DeployCodeRequest: type: object required: @@ -3213,7 +3698,7 @@ components: type: array description: An optional array of Cloud Actions. items: - $ref: '#/components/schemas/CloudActionId' + $ref: "#/components/schemas/CloudActionId" ImportSiteRequest: type: object required: @@ -3233,12 +3718,12 @@ components: properties: branch: type: string - description: The name of the branch or tag to switch to. + description: The name of the branch or tag to switch to. Tags should be prefixed with "tags/". cloud-actions: type: array description: An optional array of Cloud Actions. items: - $ref: '#/components/schemas/CloudActionId' + $ref: "#/components/schemas/CloudActionId" Ides: type: object required: @@ -3250,7 +3735,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of Cloud IDEs matching the request parameters. @@ -3260,7 +3745,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Ide' + $ref: "#/components/schemas/Ide" Ide: type: object required: @@ -3288,12 +3773,12 @@ components: - update-failed - delete-failed _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object properties: owner: - $ref: '#/components/schemas/UserProfile' + $ref: "#/components/schemas/UserProfile" IdentityProvider: type: object required: @@ -3334,7 +3819,7 @@ components: - incomplete - disabled _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" IdentityProviders: type: object required: @@ -3346,7 +3831,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of identity providers matching the request parameters. @@ -3354,7 +3839,7 @@ components: items: type: array items: - $ref: '#/components/schemas/IdentityProvider' + $ref: "#/components/schemas/IdentityProvider" ApplicationUsageMetric: type: object description: Provides details about views and visits for an application. @@ -3384,17 +3869,18 @@ components: description: The metadata for the data points being returned. properties: environment: - $ref: '#/components/schemas/EnvironmentMetadata' + $ref: "#/components/schemas/EnvironmentMetadata" application: - $ref: '#/components/schemas/ApplicationMetadata' + $ref: "#/components/schemas/ApplicationMetadata" subscription: - $ref: '#/components/schemas/SubscriptionMetadata' + $ref: "#/components/schemas/SubscriptionMetadata" last_data_at: type: string description: The last time data was polled for the requested metric. format: date-time + nullable: true _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" ApplicationUsageMetrics: type: object description: A collection of application usage metrics. @@ -3407,7 +3893,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of application metric items matching the request parameters. @@ -3415,7 +3901,7 @@ components: items: type: array items: - $ref: '#/components/schemas/ApplicationUsageMetric' + $ref: "#/components/schemas/ApplicationUsageMetric" EnvironmentUsageMetric: type: object description: Provides details about views and visits for an environment. @@ -3445,17 +3931,17 @@ components: description: The metadata for the data points being returned. properties: environment: - $ref: '#/components/schemas/EnvironmentMetadata' + $ref: "#/components/schemas/EnvironmentMetadata" application: - $ref: '#/components/schemas/ApplicationMetadata' + $ref: "#/components/schemas/ApplicationMetadata" subscription: - $ref: '#/components/schemas/SubscriptionMetadata' + $ref: "#/components/schemas/SubscriptionMetadata" last_data_at: type: string description: The last time data was polled for the requested metric. format: date-time _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" EnvironmentUsageMetrics: type: object description: A collection of usage metrics for an environment. @@ -3468,7 +3954,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of environment metric items matching the request parameters. @@ -3476,7 +3962,7 @@ components: items: type: array items: - $ref: '#/components/schemas/EnvironmentUsageMetric' + $ref: "#/components/schemas/EnvironmentUsageMetric" Metrics: type: object description: A collection of links that provides traversal of metrics endpoints. @@ -3484,7 +3970,7 @@ components: - _links properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" StackMetricsData: type: object description: An object containing StackMetrics metrics. @@ -3497,7 +3983,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of StackMetrics items matching the request parameters. @@ -3505,7 +3991,7 @@ components: items: type: array items: - $ref: '#/components/schemas/StackMetricsMetric' + $ref: "#/components/schemas/StackMetricsMetric" StackMetricsMetric: type: object description: An object containing StackMetrics datapoints. @@ -3565,7 +4051,6 @@ components: properties: host: type: string - format: uri description: The corresponding hostname for the StackMetrics datapoints. SubscriptionUsageMetric: type: object @@ -3596,17 +4081,17 @@ components: description: The metadata for the data points being returned. properties: environment: - $ref: '#/components/schemas/EnvironmentMetadata' + $ref: "#/components/schemas/EnvironmentMetadata" application: - $ref: '#/components/schemas/ApplicationMetadata' + $ref: "#/components/schemas/ApplicationMetadata" subscription: - $ref: '#/components/schemas/SubscriptionMetadata' + $ref: "#/components/schemas/SubscriptionMetadata" last_data_at: type: string description: The last time data was polled for the requested metric. format: date-time _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" SubscriptionUsageMetrics: type: object description: A collection of usage metrics for a subscription. @@ -3619,7 +4104,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of subscription metric items matching the request parameters. @@ -3627,7 +4112,7 @@ components: items: type: array items: - $ref: '#/components/schemas/SubscriptionUsageMetric' + $ref: "#/components/schemas/SubscriptionUsageMetric" Usage: type: object description: A collection of traversal links for an entity. @@ -3635,43 +4120,45 @@ components: - _links properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" + ModProxy: + type: object + required: + - status + properties: + status: + type: string + description: The enablement state of Mod Proxy. + enum: + - active + - inactive + _links: + $ref: "#/components/schemas/Links" Notification: type: object description: A notification about an event or a task. required: - - progress - - user - uuid - - name - - title + - event + - label - description - created_at - - started_at - completed_at - status - - type - - metadata - - labels + - progress + - context - _links properties: - progress: - type: integer - description: The notification progress. - minimum: 0 - maximum: 100 - user: - $ref: '#/components/schemas/UserStub' uuid: type: string description: The notification unique identifier. format: uuid - name: + event: type: string - description: The notification name. - title: + description: The notification event. + label: type: string - description: The operation title. + description: The human readable notification label. description: type: string description: The notification description. @@ -3679,10 +4166,6 @@ components: type: string format: date-time description: The time that this notification was created. - started_at: - type: string - format: date-time - description: The time that the task or event this notification is tracking was started at. completed_at: type: string format: date-time @@ -3694,7 +4177,78 @@ components: - completed - in-progress - failed - type: + progress: + type: integer + description: The notification progress. + minimum: 0 + maximum: 100 + context: + type: object + description: Contextual data related to the notification. + _links: + $ref: "#/components/schemas/Links" + _embedded: + type: object + description: Data related to the notification, such as the author. + NotificationDeprecated: + type: object + description: A notification about an event or a task. + required: + - progress + - user + - uuid + - name + - title + - description + - created_at + - started_at + - completed_at + - status + - type + - metadata + - labels + - _links + properties: + progress: + type: integer + description: The notification progress. + minimum: 0 + maximum: 100 + user: + $ref: "#/components/schemas/UserStub" + uuid: + type: string + description: The notification unique identifier. + format: uuid + name: + type: string + description: The notification name. + title: + type: string + description: The operation title. + description: + type: string + description: The notification description. + created_at: + type: string + format: date-time + description: The time that this notification was created. + started_at: + type: string + format: date-time + description: The time that the task or event this notification is tracking was started at. + completed_at: + type: string + format: date-time + description: The time that the task or event this notification is tracking was completed at. + status: + type: string + description: The status of the notification. + enum: + - completed + - in-progress + - failed + type: type: string description: The notification type. enum: @@ -3705,11 +4259,11 @@ components: description: A collection of metadata related to the notification. properties: environments: - $ref: '#/components/schemas/EnvironmentMetadata' + $ref: "#/components/schemas/EnvironmentMetadata" labels: - $ref: '#/components/schemas/NotificationLabels' + $ref: "#/components/schemas/NotificationLabels" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" NotificationLabels: type: array description: An array of various labels associated with a notification. @@ -3727,7 +4281,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of tasks matching the request parameters. @@ -3735,7 +4289,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" Organization: type: object description: Organization information. @@ -3778,7 +4332,7 @@ components: type: integer description: The number of roles this organization has. owner: - $ref: '#/components/schemas/UserStub' + $ref: "#/components/schemas/UserStub" flags: type: object description: An array of various flags that indicate functionality for the organization. @@ -3787,13 +4341,13 @@ components: type: boolean description: Indicates whether the organization supports federated authentication. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: Entities related to the organization. properties: owner: - $ref: '#/components/schemas/UserStubEmbedded' + $ref: "#/components/schemas/UserStubEmbedded" OrganizationAdminInvite: type: object description: An invitation to become an organization administrator. @@ -3823,13 +4377,13 @@ components: type: string description: The invite token. flags: - $ref: '#/components/schemas/InviteFlags' + $ref: "#/components/schemas/InviteFlags" author: - $ref: '#/components/schemas/UserStub' + $ref: "#/components/schemas/UserStub" organization: - $ref: '#/components/schemas/OrganizationStub' + $ref: "#/components/schemas/OrganizationStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" OrganizationAdminInvites: type: object description: A collection of invitations to become an organization administrator. @@ -3842,7 +4396,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: The collection of organization admin invites. @@ -3850,7 +4404,7 @@ components: items: type: array items: - $ref: '#/components/schemas/OrganizationAdminInvite' + $ref: "#/components/schemas/OrganizationAdminInvite" OrganizationAdminUserProfile: type: object description: An organization admin user profile. @@ -3879,8 +4433,8 @@ components: description: The user's last name. last_login_at: type: string - format: date-time description: The ISO-8601 formatted date/time of when the user last logged in. + nullable: true mail: type: string format: email @@ -3889,6 +4443,7 @@ components: type: string format: uri description: The URI for the user's picture. + nullable: true username: type: string description: The user's internal user name. @@ -3900,7 +4455,7 @@ components: type: boolean description: Whether or not this user is the organization owner. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" OrganizationAdminUserProfiles: type: object description: A collection of organization administrator user profiles. @@ -3913,7 +4468,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: The collection of organization admin user profiles. @@ -3921,15 +4476,20 @@ components: items: type: array items: - $ref: '#/components/schemas/OrganizationAdminUserProfile' + $ref: "#/components/schemas/OrganizationAdminUserProfile" OrganizationApplications: type: object + description: A collection of applications associated with an organization. + required: + - total + - _links + - _embedded properties: total: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of applications. @@ -3937,7 +4497,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Application' + $ref: "#/components/schemas/ApplicationNoEmbedded" OrganizationAvailableTags: type: object description: A collection of organization members. @@ -3950,7 +4510,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of tags associated with the organization. @@ -3958,7 +4518,7 @@ components: items: type: array items: - $ref: '#/components/schemas/ResourceTag' + $ref: "#/components/schemas/ResourceTagOrganization" OrganizationMembers: type: object description: A collection of organization members. @@ -3971,7 +4531,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of organization member profiles. @@ -3979,7 +4539,58 @@ components: items: type: array items: - $ref: '#/components/schemas/OrganizationUserProfile' + $ref: "#/components/schemas/OrganizationUserProfile" + OrganizationNoEmbedded: + type: object + description: Organization information. + required: + - id + - uuid + - name + - subscriptions_total + - admins_total + - users_total + - teams_total + - roles_total + - owner + - flags + - _links + properties: + id: + type: string + description: The internal ID of the organization. + uuid: + type: string + description: The UUID of the organization. + name: + type: string + description: The name of the organization. + subscriptions_total: + type: integer + description: The number of subscriptions this organization has. + admins_total: + type: integer + description: The number of administrators this organization has. + users_total: + type: integer + description: The number of users this organization has. + teams_total: + type: integer + description: The number of teams this organization has. + roles_total: + type: integer + description: The number of roles this organization has. + owner: + $ref: "#/components/schemas/UserStub" + flags: + type: object + description: An array of various flags that indicate functionality for the organization. + properties: + federated_authentication: + type: boolean + description: Indicates whether the organization supports federated authentication. + _links: + $ref: "#/components/schemas/Links" Organizations: type: object description: A collection of all organizations the current user has access to. @@ -3988,7 +4599,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of organizations. @@ -3996,7 +4607,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/OrganizationNoEmbedded" OrganizationsNotifications: type: object description: A collection of notifications matching the request parameters. @@ -4005,9 +4616,9 @@ components: type: integer description: The number of items returned in the collection. pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of notifications matching the request parameters. @@ -4015,7 +4626,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Notification' + $ref: "#/components/schemas/Notification" OrganizationStub: type: object required: @@ -4044,7 +4655,7 @@ components: type: string description: The human-readable organization name. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" OrganizationTeamInvite: type: object required: @@ -4064,11 +4675,11 @@ components: type: array description: A array of applications this invite is granting access to. items: - $ref: '#/components/schemas/ApplicationStub' + $ref: "#/components/schemas/ApplicationStub" author: - $ref: '#/components/schemas/UserStub' + $ref: "#/components/schemas/UserStub" organization: - $ref: '#/components/schemas/OrganizationStub' + $ref: "#/components/schemas/OrganizationStub" uuid: type: string description: The unique identifier of the Invite. @@ -4085,16 +4696,16 @@ components: type: string description: The invite token. flags: - $ref: '#/components/schemas/InviteFlags' + $ref: "#/components/schemas/InviteFlags" team: - $ref: '#/components/schemas/TeamStub' + $ref: "#/components/schemas/TeamStub" roles: type: array description: List of roles the invite will grant the invitee. items: - $ref: '#/components/schemas/RoleStub' + $ref: "#/components/schemas/RoleStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" OrganizationTeamInvites: type: object description: A collection of invitations to join a team. @@ -4107,7 +4718,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: The collection of organization team invites. @@ -4115,7 +4726,7 @@ components: items: type: array items: - $ref: '#/components/schemas/OrganizationTeamInvite' + $ref: "#/components/schemas/OrganizationTeamInvite" OrganizationTeamStub: type: object description: A team within an organization. @@ -4135,7 +4746,7 @@ components: type: array description: An array of roles that the user has on this team. items: - $ref: '#/components/schemas/RoleStub' + $ref: "#/components/schemas/RoleStub" OrganizationUserProfile: type: object description: A user profile for an organization member. @@ -4167,16 +4778,17 @@ components: type: string format: uri description: The URL for the user's picture. + nullable: true username: type: string description: The user's internal user name. teams: type: array - description: 'A collection of teams this user has access to in an organization, and the roles they have on those teams.' + description: A collection of teams this user has access to in an organization, and the roles they have on those teams. items: - $ref: '#/components/schemas/OrganizationTeamStub' + $ref: "#/components/schemas/OrganizationTeamStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" CdeSize: type: object description: Response schema for a CDE size. @@ -4217,7 +4829,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: The collection of CDE sizes. @@ -4225,7 +4837,7 @@ components: items: type: array items: - $ref: '#/components/schemas/CdeSize' + $ref: "#/components/schemas/CdeSize" LogForwardingSource: type: object description: Response schema for a Log forwarding source. @@ -4257,7 +4869,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: The collection of Log forwarding sources. @@ -4265,7 +4877,7 @@ components: items: type: array items: - $ref: '#/components/schemas/LogForwardingSource' + $ref: "#/components/schemas/LogForwardingSource" LogForwardingConsumer: type: object description: Response schema for a Log forwarding consumer. @@ -4290,7 +4902,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: The collection of Log forwarding consumers. @@ -4298,7 +4910,7 @@ components: items: type: array items: - $ref: '#/components/schemas/LogForwardingConsumer' + $ref: "#/components/schemas/LogForwardingConsumer" Color: type: object description: Response schema for a color. @@ -4319,7 +4931,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: The collection of colors. @@ -4327,7 +4939,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Color' + $ref: "#/components/schemas/Color" ConfigurationSet: type: object description: An Acquia Search configuration set. @@ -4364,9 +4976,9 @@ components: - failed - inactive health: - $ref: '#/components/schemas/Health' + $ref: "#/components/schemas/Health" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" ConfigurationSets: type: object description: A collection of configuration sets. @@ -4375,9 +4987,9 @@ components: type: integer description: The number of items returned in the collection. pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of configuration sets. @@ -4385,7 +4997,7 @@ components: items: type: array items: - $ref: '#/components/schemas/ConfigurationSet' + $ref: "#/components/schemas/ConfigurationSet" Index: type: object description: An Acquia Search index. @@ -4421,7 +5033,7 @@ components: - failed - inactive health: - $ref: '#/components/schemas/Health' + $ref: "#/components/schemas/Health" solr_version: type: string description: The Solr version the index is currently running on. @@ -4429,13 +5041,13 @@ components: type: string description: The index URL. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: The configuration set associated with the index. properties: configuration_set: - $ref: '#/components/schemas/ConfigurationSet' + $ref: "#/components/schemas/ConfigurationSet" Indexes: type: object description: A collection of indexes. @@ -4444,9 +5056,9 @@ components: type: integer description: The number of items returned in the collection. pagination: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of indexes. @@ -4454,7 +5066,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Index' + $ref: "#/components/schemas/Index" Search: type: object description: A collection of links that provides traversal of search endpoints. @@ -4462,7 +5074,7 @@ components: - _links properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Server: type: object description: Server information. @@ -4490,7 +5102,6 @@ components: description: The machine name of the server. hostname: type: string - format: uri description: The hostname for the server. ssh_user: type: string @@ -4513,7 +5124,7 @@ components: description: The Amazon region the server is in. roles: type: array - description: 'The roles the server has, for its environment.' + description: The roles the server has, for its environment. items: type: string enum: @@ -4527,13 +5138,13 @@ components: type: string description: The operating system running on the server. configuration: - $ref: '#/components/schemas/ServerConfiguration' + $ref: "#/components/schemas/ServerConfiguration" flags: - $ref: '#/components/schemas/ServerFlags' + $ref: "#/components/schemas/ServerFlags" environment: - $ref: '#/components/schemas/EnvironmentStub' + $ref: "#/components/schemas/EnvironmentStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Servers: type: object required: @@ -4546,7 +5157,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of servers matching the request parameters. @@ -4554,7 +5165,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Server' + $ref: "#/components/schemas/Server" ServerConfiguration: type: object description: An array of various configuration settings for the server. @@ -4562,12 +5173,15 @@ components: ecu: type: integer description: The number of EC2 Compute Units (ECU) for this server type. + nullable: true memory: type: number description: Returns the memory size (in GB) for this server type. + nullable: true memcache: type: integer description: Returns the memcache size (in MB) for this server (if it is a memcache server). + nullable: true ServerFlags: type: object description: An array of various flags that indicate functionality for the server. @@ -4616,7 +5230,7 @@ components: description: Information about the server this cron job is attached to. properties: id: - type: integer + type: string description: The server ID. name: type: string @@ -4625,7 +5239,7 @@ components: type: object properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" HostingSettings: type: object properties: @@ -4640,7 +5254,7 @@ components: type: string description: The application's hosting type. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" LegacyProductKeysSettings: type: object properties: @@ -4666,7 +5280,7 @@ components: type: string description: The Cloud API key. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" RemoteAdministrationSettings: type: object properties: @@ -4689,11 +5303,9 @@ components: - core_contrib pause_until: type: string - format: date-time description: The ISO-8601 formatted date/time to pause RA until. Only applicable for 'full' and 'inform' update modes and when it is in future. deploy_at: type: string - format: date-time description: The ISO-8601 formatted date/time to deploy RA at. Only applicable for 'full' and 'inform' update modes and when it is in future. deploy_environment: type: string @@ -4716,7 +5328,7 @@ components: merge_tag: type: boolean _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" SecuritySettings: type: object properties: @@ -4733,7 +5345,7 @@ components: type: boolean description: Whether TFA is required for an application. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" ShieldAclCollection: type: object description: Collection of Shield ACL rules. @@ -4746,7 +5358,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of Shield ACL rules. @@ -4754,7 +5366,7 @@ components: items: type: array items: - $ref: '#/components/schemas/ShieldAcl' + $ref: "#/components/schemas/ShieldAcl" ShieldAcl: type: object description: Shield ACL rule. @@ -4773,7 +5385,7 @@ components: description: The unique identifier of the rule. format: uuid subscription: - $ref: '#/components/schemas/SubscriptionStub' + $ref: "#/components/schemas/SubscriptionStub" description: type: string description: The rule description. @@ -4802,7 +5414,7 @@ components: - active - inactive _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" ApmType: type: object required: @@ -4827,7 +5439,7 @@ components: type: string description: The APM license key. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" ApmTypes: type: object required: @@ -4839,7 +5451,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of APM types matching the request parameters. @@ -4847,7 +5459,7 @@ components: items: type: array items: - $ref: '#/components/schemas/ApmType' + $ref: "#/components/schemas/ApmType" Subscription: type: object description: | @@ -4880,11 +5492,9 @@ components: start_at: type: string description: The time when the service defined by the subscription becomes available. - format: date-time expire_at: type: string description: The time when the service expires. - format: date-time product: type: object description: Defines the type of service this subscription is entitled to. @@ -4919,9 +5529,9 @@ components: type: string description: The human-readable organization name. flags: - $ref: '#/components/schemas/SubscriptionFlags' + $ref: "#/components/schemas/SubscriptionFlags" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of resources related to the subscription. @@ -4929,22 +5539,41 @@ components: items: type: array items: - $ref: '#/components/schemas/OrganizationStub' + $ref: "#/components/schemas/OrganizationStub" + SubscriptionApplications: + type: object + description: A collection of applications associated with a subscription. + required: + - total + - _links + - _embedded + properties: + total: + type: integer + description: The number of items returned in the collection. + _links: + $ref: "#/components/schemas/Links" + _embedded: + type: object + description: A collection of applications. + properties: + items: + type: array + items: + $ref: "#/components/schemas/ApplicationNoEmbedded" SubscriptionFlags: type: object description: An array of various flags that indicate functionality associated with subscription. - additionalProperties: - type: object - properties: - active: - type: boolean - description: If the subscription is active. - expired: - type: boolean - description: If the subscription is expired. - zuora: - type: boolean - description: If the subscription is online paid. + properties: + active: + type: boolean + description: If the subscription is active. + expired: + type: boolean + description: If the subscription is expired. + zuora: + type: boolean + description: If the subscription is online paid. SubscriptionMetadata: type: object description: Subscription metadata. @@ -4963,7 +5592,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of subscriptions. @@ -4971,7 +5600,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" SubscriptionStub: type: object description: The subscription this application belongs to. @@ -5002,7 +5631,7 @@ components: type: string description: The name of the subscription. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Task: type: object required: @@ -5023,11 +5652,11 @@ components: properties: progress: type: integer - description: 'The progress of the event, from 0 to 100.' + description: The progress of the event, from 0 to 100. minimum: 0 maximum: 100 user: - $ref: '#/components/schemas/UserStub' + $ref: "#/components/schemas/UserStub" uuid: type: string format: uuid @@ -5061,11 +5690,19 @@ components: type: string description: The type of task. metadata: - type: array - description: Metadata for the task. - items: - anyOf: - - $ref: '#/components/schemas/EnvironmentMetadata' + type: object + properties: + created: + type: integer + description: When the task was created. + author: + type: object + description: The task author. + properties: + uuid: + type: string + description: The task author UUID. + format: uuid labels: type: array description: Categorization labels associated with the task @@ -5074,9 +5711,9 @@ components: reference_uuid: type: string format: uuid - description: 'The UUID of the parent task. If there is no parent, this will be the task UUID.' + description: The UUID of the parent task. If there is no parent, this will be the task UUID. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Invite: type: object required: @@ -5105,25 +5742,25 @@ components: type: string description: The invite token. flags: - $ref: '#/components/schemas/InviteFlags' + $ref: "#/components/schemas/InviteFlags" author: - $ref: '#/components/schemas/UserStub' + $ref: "#/components/schemas/UserStub" organization: - $ref: '#/components/schemas/OrganizationStub' + $ref: "#/components/schemas/OrganizationStub" team: - $ref: '#/components/schemas/TeamStub' + $ref: "#/components/schemas/TeamStub" applications: type: array description: List of applications the invite will grant the invitee. items: - $ref: '#/components/schemas/ApplicationStub' + $ref: "#/components/schemas/ApplicationStub" roles: type: array description: List of roles the invite will grant the invitee. items: - $ref: '#/components/schemas/RoleStub' + $ref: "#/components/schemas/RoleStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" InviteFlags: type: object description: An array of various flags providing more context for the Invite response object. @@ -5148,11 +5785,12 @@ components: description: type: string description: The description of the permission. + nullable: true group_label: type: string description: The human readable label for the group. flags: - $ref: '#/components/schemas/PermissionFlags' + $ref: "#/components/schemas/PermissionFlags" PermissionFlags: type: object description: An array of various flags regarding the status of the permission. @@ -5168,7 +5806,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of permissions. @@ -5176,7 +5814,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Permission' + $ref: "#/components/schemas/Permission" PostInvite: type: object required: @@ -5210,26 +5848,26 @@ components: type: array description: A collection of permissions a user with this role is granted. items: - $ref: '#/components/schemas/Permission' + $ref: "#/components/schemas/Permission" organization: - $ref: '#/components/schemas/OrganizationStub' + $ref: "#/components/schemas/OrganizationStub" last_edited: type: object - description: 'When the role was last edited, and who edited it.' + description: When the role was last edited, and who edited it. properties: edited_at: type: string format: date-time description: The date the role was edited. user: - $ref: '#/components/schemas/UserStub' + $ref: "#/components/schemas/UserStub" flags: type: object description: Additional role status information. properties: default: type: boolean - description: 'True if this is a default role, false if it was user created.' + description: True if this is a default role, false if it was user created. Roles: type: object description: Collection of roles. @@ -5238,7 +5876,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of roles. @@ -5246,7 +5884,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Role' + $ref: "#/components/schemas/Role" RoleStub: type: object required: @@ -5286,9 +5924,9 @@ components: format: date-time description: The date the team was last updated. organization: - $ref: '#/components/schemas/OrganizationStub' + $ref: "#/components/schemas/OrganizationStub" _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" TeamInvites: type: object description: A collection of invites. @@ -5301,7 +5939,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of invites matching the request parameters. @@ -5309,7 +5947,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Invite' + $ref: "#/components/schemas/Invite" Teams: type: object description: A collection of teams. @@ -5322,7 +5960,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of teams matching the request parameters. @@ -5330,7 +5968,28 @@ components: items: type: array items: - $ref: '#/components/schemas/Team' + $ref: "#/components/schemas/Team" + TeamApplications: + type: object + description: A collection of applications associated with a team. + required: + - total + - _links + - _embedded + properties: + total: + type: integer + description: The number of items returned in the collection. + _links: + $ref: "#/components/schemas/Links" + _embedded: + type: object + description: A collection of applications. + properties: + items: + type: array + items: + $ref: "#/components/schemas/ApplicationNoEmbedded" TeamMembers: type: object description: A collection of team members. @@ -5343,7 +6002,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of team member profiles. @@ -5351,7 +6010,7 @@ components: items: type: array items: - $ref: '#/components/schemas/TeamUserProfile' + $ref: "#/components/schemas/TeamUserProfile" TeamStub: type: object required: @@ -5402,7 +6061,7 @@ components: type: array description: A collection of roles this user has access to on a team. items: - $ref: '#/components/schemas/RoleStub' + $ref: "#/components/schemas/RoleStub" HasPermission: type: object description: Determines if a user account has a specific permission. @@ -5414,7 +6073,7 @@ components: type: boolean description: Whether or not the user account has the specific permission. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" IsAdministrator: type: object required: @@ -5426,7 +6085,7 @@ components: type: boolean description: Whether or not the user account is an administrator. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" IsOwner: type: object required: @@ -5438,7 +6097,7 @@ components: type: boolean description: Whether or not the user account is an owner. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" PasswordValidation: type: object description: The password validation response. @@ -5476,7 +6135,7 @@ components: format: date-time description: The key creation date. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" SshKeys: type: object required: @@ -5489,7 +6148,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of SSH keys matching the request parameters. @@ -5497,14 +6156,14 @@ components: items: type: array items: - $ref: '#/components/schemas/SshKey' + $ref: "#/components/schemas/SshKey" Token: type: object required: - uuid - active - label - - revokation + - revocation - flags - created_at - _links @@ -5520,9 +6179,10 @@ components: label: type: string description: The human-readable name for this token. - revokation: + revocation: type: string - description: 'If set, the reason why this token was revoked.' + description: If set, the reason why this token was revoked. + nullable: true flags: type: object description: Flags detailing the token's status. @@ -5535,7 +6195,7 @@ components: format: date-time description: The creation date and time. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" TokenCreation: type: object required: @@ -5551,7 +6211,7 @@ components: type: string description: The API key secret. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" Tokens: type: object required: @@ -5564,7 +6224,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of tokens matching the request parameters. @@ -5572,7 +6232,7 @@ components: items: type: array items: - $ref: '#/components/schemas/Token' + $ref: "#/components/schemas/Token" User: type: object required: @@ -5617,6 +6277,7 @@ components: type: string format: date-time description: The date/time of the last login for the user. + nullable: true created_at: type: string format: date-time @@ -5632,9 +6293,11 @@ components: office: type: string description: The office telephone number for the user. + nullable: true tfa: type: string description: The tfa backup telephone number for the user. + nullable: true job_title: type: string description: The job title of the user. @@ -5642,7 +6305,7 @@ components: type: string description: The job function of the user. enum: - - '--' + - -- - Business Executive - IT Executive - IT Architect or IT Operations @@ -5655,7 +6318,7 @@ components: type: string description: The country of the user. enum: - - '--' + - -- - United States - Afghanistan - Albania @@ -5883,7 +6546,7 @@ components: - Zimbabwe state: type: string - description: 'The state of the user, if in the United States.' + description: The state of the user, if in the United States. enum: - Alabama - Alaska @@ -5960,7 +6623,7 @@ components: - php71 - platform flags: - $ref: '#/components/schemas/UserFlags' + $ref: "#/components/schemas/UserFlags" metadata: type: object description: Metadata related to the user. @@ -5990,22 +6653,20 @@ components: type: string format: uuid _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" UserFlags: type: object description: The various flags for the user. - additionalProperties: - type: object - properties: - active: - type: boolean - description: Whether or not this user is active. - tfa: - type: boolean - description: Whether or not this user has TFA enabled. - support: - type: boolean - description: Whether or not this user is a member of Acquia support. + properties: + active: + type: boolean + description: Whether or not this user is active. + tfa: + type: boolean + description: Whether or not this user has TFA enabled. + support: + type: boolean + description: Whether or not this user is a member of Acquia support. UserProfile: type: object description: A user profile. @@ -6033,6 +6694,7 @@ components: type: string format: date-time description: The date/time of the last login for the user. + nullable: true created_at: type: string format: date-time @@ -6045,6 +6707,7 @@ components: type: string format: uri description: The URL for the user's picture. + nullable: true username: type: string description: The user's internal user name. @@ -6076,6 +6739,7 @@ components: type: string format: uri description: The URI for the user's picture. + nullable: true username: type: string description: The user's internal user name. @@ -6109,11 +6773,45 @@ components: type: string format: uri description: The URI for the user's picture. + nullable: true username: type: string description: The user's internal user name. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" + UserStubNullable: + type: object + nullable: true + required: + - uuid + - first_name + - last_name + - mail + - picture_url + - username + properties: + uuid: + type: string + format: uuid + description: The user's UUID. + first_name: + type: string + description: The user's first name. + last_name: + type: string + description: The user's last name. + mail: + type: string + format: email + description: The user's email address. + picture_url: + type: string + format: uri + description: The URI for the user's picture. + nullable: true + username: + type: string + description: The user's internal user name. PasswordRequest: type: object required: @@ -6157,7 +6855,7 @@ components: type: integer description: The number of items returned in the collection. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" _embedded: type: object description: A collection of application messages matching the request parameters. @@ -6165,7 +6863,7 @@ components: items: type: array items: - $ref: '#/components/schemas/UxMessage' + $ref: "#/components/schemas/UxMessage" UxMessage: type: object required: @@ -6194,14 +6892,16 @@ components: body: type: string description: The message body. + nullable: true url: type: string format: uri description: The message url. + nullable: true filters: - $ref: '#/components/schemas/UxMessageFilters' + $ref: "#/components/schemas/UxMessageFilters" flags: - $ref: '#/components/schemas/UxMessageFlags' + $ref: "#/components/schemas/UxMessageFlags" weight: type: integer description: The message priority weight. @@ -6214,7 +6914,7 @@ components: format: date-time description: The UTC timestamp of when the message expires. _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" UxMessageFilters: type: object description: Defines where a message should appear. @@ -6265,8 +6965,7 @@ components: 6. Copy your API key and API secret. Click **OK**. flows: clientCredentials: - authorizationUrl: 'https://accounts.acquia.com/api/authorize' - tokenUrl: 'https://accounts.acquia.com/api/token' + tokenUrl: https://accounts.acquia.com/api/token scopes: {} paths: /: @@ -6274,16 +6973,16 @@ paths: tags: - Current system health summary: Return the current system health status. - description: 'Returns status checks for system database, configuration and registry.' + description: Returns status checks for system database, configuration and registry. operationId: getSystemHealthStatus x-cli-name: system-health-status responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Root' + $ref: "#/components/schemas/Root" example: status: configuration: true @@ -6292,21 +6991,21 @@ paths: acf_provisioning_enabled: true _links: self: - href: 'https://cloud.acquia.com/api/' + href: https://cloud.acquia.com/api/ account: - href: 'https://cloud.acquia.com/api/account' + href: https://cloud.acquia.com/api/account applications: - href: 'https://cloud.acquia.com/api/applications' + href: https://cloud.acquia.com/api/applications distributions: - href: 'https://cloud.acquia.com/api/distributions' + href: https://cloud.acquia.com/api/distributions identity-providers: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers organizations: - href: 'https://cloud.acquia.com/api/organizations' + href: https://cloud.acquia.com/api/organizations subscriptions: - href: 'https://cloud.acquia.com/api/subscriptions' + href: https://cloud.acquia.com/api/subscriptions teams: - href: 'https://cloud.acquia.com/api/teams' + href: https://cloud.acquia.com/api/teams /account: get: tags: @@ -6314,14 +7013,14 @@ paths: summary: Returns details about your account. description: Returns details about your account. operationId: getAccount - x-cli-name: 'accounts:find' + x-cli-name: accounts:find responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" example: id: 1234567 uuid: 82cff7ec-2f09-11e9-b210-d663bd873d93 @@ -6333,27 +7032,27 @@ paths: mail: jane.doe@example.com phone: office: null - mobile: '5555555555' - tfa: '5555555555' - job_title: null - job_function: Digital Marketing - company: 'Acquia, Inc.' - country: USA - state: MA + mobile: "5555555555" + tfa: "5555555555" + job_title: "" + job_function: IT Executive + company: Acquia, Inc. + country: United States + state: Massachusetts timezone: America/New_York - picture_url: 'https://accounts.acquia.com/images/users/82cff7ec-2f09-11e9-b210-d663bd873d93/style/avatar' + picture_url: https://accounts.acquia.com/images/users/82cff7ec-2f09-11e9-b210-d663bd873d93/style/avatar features: - - freetier-bonus - - uptime + - ci-pipelines + - on-demand-environments metadata: applications: recent: - uuid: 8b83a104-2f09-11e9-b210-d663bd873d93 - recent_at: '2016-03-04T13:07:54-0500' + recent_at: 2016-03-04T13:07:54-0500 - uuid: 8b83a104-2f09-11e9-b210-d663bd873d93 - recent_at: '2016-03-04T12:01:07-0500' + recent_at: 2016-03-04T12:01:07-0500 - uuid: 8b83a104-2f09-11e9-b210-d663bd873d93 - recent_at: '2016-03-04T12:01:05-0500' + recent_at: 2016-03-04T12:01:05-0500 starred: - 987c5c48-2f09-11e9-b210-d663bd873d93 - 9b684e30-2f09-11e9-b210-d663bd873d93 @@ -6363,302 +7062,302 @@ paths: support: false _links: self: - href: 'https://cloud.acquia.com/api/account' + href: https://cloud.acquia.com/api/account invites: - href: 'https://cloud.acquia.com/api/account/invites' + href: https://cloud.acquia.com/api/account/invites messages: - href: 'https://cloud.acquia.com/api/account/messages' + href: https://cloud.acquia.com/api/account/messages tokens: - href: 'https://cloud.acquia.com/api/account/tokens' + href: https://cloud.acquia.com/api/account/tokens parent: - href: 'https://cloud.acquia.com/api/' - '404': + href: https://cloud.acquia.com/api/ + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Does not exist: value: error: not_found - message: 'The user does not exist, or you do not have access to it.' - '/account/applications/{applicationUuid}/has-permission': + message: The user does not exist, or you do not have access to it. + "/account/applications/{applicationUuid}/has-permission": get: tags: - Account summary: Returns whether your account has access to a specific application permission. description: Returns whether your account has access to a specific application permission. operationId: getAccountApplicationHasPermission - x-cli-name: 'accounts:application-has-permission' + x-cli-name: accounts:application-has-permission parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Permission' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Permission" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/HasPermission' + $ref: "#/components/schemas/HasPermission" example: access: true _links: self: - href: 'https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/has-permission?permission=deploy%20to%20prod' + href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/has-permission?permission=deploy%20to%20prod application: - href: 'https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93' - '403': + href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Do not have permission: value: error: forbidden message: You do not have the 'example permission' permission for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. Permission not found: value: error: not_found message: The permission you are trying to look up does not exist. - '/account/applications/{applicationUuid}/is-admin': + "/account/applications/{applicationUuid}/is-admin": get: tags: - Account summary: Returns whether your account is an administrator for an application. description: Returns whether your account is an administrator for an application. operationId: getAccountApplicationIsAdministrator - x-cli-name: 'accounts:is-application-admin' + x-cli-name: accounts:is-application-admin parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IsAdministrator' + $ref: "#/components/schemas/IsAdministrator" example: admin: true _links: self: - href: 'https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/is-admin' + href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/is-admin application: - href: 'https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93' - '403': + href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Do not have permission: value: error: forbidden message: You do not have permission to administer this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/account/applications/{applicationUuid}/is-owner': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/account/applications/{applicationUuid}/is-owner": get: tags: - Account summary: Returns whether your account is the owner for an application. description: Returns whether your account is the owner for an application. operationId: getAccountApplicationIsOwner - x-cli-name: 'accounts:is-application-owner' + x-cli-name: accounts:is-application-owner parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IsOwner' + $ref: "#/components/schemas/IsOwner" example: owner: true _links: self: - href: 'https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/is-owner' + href: https://cloud.acquia.com/api/account/applications/27a861f0-2fdc-11e9-b210-d663bd873d93/is-owner application: - href: 'https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93' - '404': + href: https://cloud.acquia.com/api/applications/27a861f0-2fdc-11e9-b210-d663bd873d93 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/account/applications/{applicationUuid}/actions/mark-recent': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/account/applications/{applicationUuid}/actions/mark-recent": post: tags: - Account summary: Marks an application as recently viewed. description: Marks an application as recently viewed. UUIDs and timestamps of recent applications are present in the "account" endpoint. operationId: postAccountApplicationMarkRecent - x-cli-name: 'accounts:application-mark-recent' + x-cli-name: accounts:application-mark-recent parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Marked as recently viewed: value: message: The application has been marked as recently viewed. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Does not exist: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already on the recently viewed list: value: error: conflict message: Unable to add an application to the recently viewed list. - '/account/applications/{applicationUuid}/actions/star': + "/account/applications/{applicationUuid}/actions/star": post: tags: - Account summary: Stars an application. description: Stars an application. UUIDs of starred applications are present in the "account" endpoint. operationId: postAccountApplicationStar - x-cli-name: 'accounts:application-star' + x-cli-name: accounts:application-star parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Starred: value: message: The application has been starred. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Does not exist: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. User does not have access: value: error: not_found message: The user does not have access to this application. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Unable to add: value: error: conflict message: The application has already been starred by this user. - '/account/applications/{applicationUuid}/actions/unstar': + "/account/applications/{applicationUuid}/actions/unstar": post: tags: - Account summary: Removes an application from the user's starred list. description: Removes an application from the user's starred list. UUIDs of starred applications are present in the "account" endpoint. operationId: postAccountApplicationUnstar - x-cli-name: 'accounts:application-unstar' + x-cli-name: accounts:application-unstar parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Starred: value: message: The application has been unstarred. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Does not exist: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. User does not have access: value: error: not_found message: The user does not have access to this application. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Unable to add: value: @@ -6671,33 +7370,33 @@ paths: summary: Returns the drush aliases as a compressed archive download. description: Returns the drush aliases as a compressed archive download. operationId: getAccountDrushAliasesDownload - x-cli-name: 'accounts:drush-aliases' + x-cli-name: accounts:drush-aliases parameters: - - $ref: '#/components/parameters/DrushVersion' + - $ref: "#/components/parameters/DrushVersion" responses: - '200': + "200": description: OK content: application/gzip: schema: - $ref: '#/components/schemas/File' - '403': + $ref: "#/components/schemas/File" + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Version not supported: value: error: forbidden message: Only Drush 8 and 9 are supported. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No Cloud API key found: value: @@ -6714,7 +7413,7 @@ paths: User not found: value: error: not_found - message: 'The user does not exist, or you do not have access to it.' + message: The user does not exist, or you do not have access to it. /account/ides: get: tags: @@ -6722,21 +7421,21 @@ paths: summary: Returns a list of Cloud IDEs associated with the current user. description: Returns a list of Cloud IDEs associated with the current user. operationId: getAccountIdes - x-cli-name: 'accounts:ide-list' + x-cli-name: accounts:ide-list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Ides' + $ref: "#/components/schemas/Ides" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/account/ides' + href: https://cloud.acquia.com/api/account/ides parent: - href: 'https://cloud.acquia.com/api/account' + href: https://cloud.acquia.com/api/account _embedded: items: - uuid: 9a83c081-ef78-4dbd-8852-11cc3eb248f7 @@ -6744,36 +7443,36 @@ paths: status: active _links: self: - href: 'https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7' + href: https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7 web: - href: 'https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud' + href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud ide: - href: 'https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ide.ahdev.cloud' + href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ide.ahdev.cloud application: - href: 'https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199' + href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199 - uuid: feea197a-9503-4441-9f49-b4d420b0ecf8 label: IDE Label 2 status: active _links: self: - href: 'https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8' + href: https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8 web: - href: 'https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud' + href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud ide: - href: 'https://feea197a-9503-4441-9f49-b4d420b0ecf8.ide.ahdev.cloud' + href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.ide.ahdev.cloud application: - href: 'https://cloud.acquia.com/api/applications/cc26f963-6e9e-49df-a159-230f75e455aa' - '404': + href: https://cloud.acquia.com/api/applications/cc26f963-6e9e-49df-a159-230f75e455aa + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: User not found: value: error: not_found - message: 'The user does not exist, or you do not have access to it.' + message: The user does not exist, or you do not have access to it. /account/invites: get: tags: @@ -6792,35 +7491,51 @@ paths: * `token` * `author` operationId: getAccountInvites - x-cli-name: 'accounts:invites-list' - parameters: - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + x-cli-name: accounts:invites-list + parameters: + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/AccountInvites' + $ref: "#/components/schemas/AccountInvites" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/account/invites' + href: https://cloud.acquia.com/api/account/invites parent: - href: 'https://cloud.acquia.com/api/account' + href: https://cloud.acquia.com/api/account _embedded: items: - - organization: + - applications: + - uuid: a6a494aa-1316-4867-b681-95e3d77a6b34 + name: Example application + author: + uuid: 0f1915e8-cd84-4386-94b8-21926fc376f5 + username: jane.doe + 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 + organization: name: Organization Name uuid: e83c3532-2fe0-11e9-b210-d663bd873d93 + roles: + - uuid: fe79cb7a-2fe0-11e9-b210-d663bd873d93 + name: Senior Developer + team: + uuid: 01d73cf8-2fe1-11e9-b210-d663bd873d93 + name: Team Name uuid: eb947b2c-2fe0-11e9-b210-d663bd873d93 email: invitee@example.com created_at: '2012-05-15T12:00:00Z' @@ -6829,15 +7544,19 @@ paths: declined: false _links: self: - href: 'https://cloud.acquia.com/api/invites/eb947b2c-2fe0-11e9-b210-d663bd873d93' + href: https://cloud.acquia.com/api/invites/eb947b2c-2fe0-11e9-b210-d663bd873d93 organization: - href: 'https://cloud.acquia.com/api/organizations/e83c3532-2fe0-11e9-b210-d663bd873d93' - - roles: - - uuid: fe79cb7a-2fe0-11e9-b210-d663bd873d93 - name: Senior Developer - team: - uuid: 01d73cf8-2fe1-11e9-b210-d663bd873d93 - name: Team Name + href: https://cloud.acquia.com/api/organizations/e83c3532-2fe0-11e9-b210-d663bd873d93 + - organization: + name: Organization Name + uuid: e83c3532-2fe0-11e9-b210-d663bd873d93 + author: + uuid: 0f1915e8-cd84-4386-94b8-21926fc376f5 + username: jane.doe + 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 uuid: 0540f4ba-2fe1-11e9-b210-d663bd873d93 email: invitee@example.com created_at: '2012-05-15T12:00:00Z' @@ -6846,20 +7565,20 @@ paths: declined: false _links: self: - href: 'https://cloud.acquia.com/api/invites/0540f4ba-2fe1-11e9-b210-d663bd873d93' - team: - href: 'https://cloud.acquia.com/api/teams/01d73cf8-2fe1-11e9-b210-d663bd873d93' - '404': + href: https://cloud.acquia.com/api/invites/0540f4ba-2fe1-11e9-b210-d663bd873d93 + organization: + href: https://cloud.acquia.com/api/organizations/e83c3532-2fe0-11e9-b210-d663bd873d93 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: User not found: value: error: not_found - message: 'The user does not exist, or you do not have access to it.' + message: The user does not exist, or you do not have access to it. /account/messages: get: tags: @@ -6878,23 +7597,23 @@ paths: * `message_type` * `display_mode` operationId: getAccountMessages - x-cli-name: 'accounts:messages-list' - parameters: - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + x-cli-name: accounts:messages-list + parameters: + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/UxMessages' + $ref: "#/components/schemas/UxMessages" example: total: 2 pagination: @@ -6903,20 +7622,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/messages' + href: https://cloud.acquia.com/api/messages parent: - href: 'https://cloud.acquia.com/api/' + href: https://cloud.acquia.com/api/ filter: - href: 'https://cloud.acquia.com/api/messages{?filter}' + href: https://cloud.acquia.com/api/messages{?filter} templated: true sort: - href: 'https://cloud.acquia.com/api/messages{?sort}' + href: https://cloud.acquia.com/api/messages{?sort} templated: true limit: - href: 'https://cloud.acquia.com/api/messages{?limit}' + href: https://cloud.acquia.com/api/messages{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/messages{?offset}' + href: https://cloud.acquia.com/api/messages{?offset} templated: true _embedded: items: @@ -6928,21 +7647,21 @@ paths: filters: type: alert display_mode: bar - paths: null + paths: [] flags: dismissed: false dismissible: true active: true weight: -1 - start_at: '2019-07-07T09:45:00-04:00' - expire_at: '2019-07-15T09:45:00-04:00' + start_at: 2019-07-07T09:45:00-04:00 + expire_at: 2019-07-15T09:45:00-04:00 _links: self: - href: 'https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2' + href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2 dismiss: - href: 'https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/dismiss' + href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/dismiss follow: - href: 'https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/follow' + href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/follow - id: 883581 uuid: 17ff551f-a037-4c0a-a0cb-ad6616ab3aa3 title: Another example title @@ -6951,117 +7670,117 @@ paths: filters: type: alert display_mode: bar - paths: null + paths: [] flags: dismissed: false dismissible: true active: true weight: -1 - start_at: '2019-07-07T09:45:00-04:00' - expire_at: '2019-07-15T09:45:00-04:00' + start_at: 2019-07-07T09:45:00-04:00 + expire_at: 2019-07-15T09:45:00-04:00 _links: self: - href: 'https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2' + href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2 dismiss: - href: 'https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/dismiss' + href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/dismiss follow: - href: 'https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/follow' - '404': + href: https://cloud.acquia.com/api/messages/17ff551f-a037-4c0a-a0cb-ad6616ab3aa2/actions/follow + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Messages not found: value: error: not_found - message: 'The messages you are trying to view do not exist, or you do not have permission to access them.' - '/account/organizations/{organizationUuid}/is-admin': + message: The messages you are trying to view do not exist, or you do not have permission to access them. + "/account/organizations/{organizationUuid}/is-admin": get: tags: - Account summary: Returns whether your account is an administrator for an organization. description: Returns whether your account is an administrator for an organization. operationId: getAccountOrganizationIsAdministrator - x-cli-name: 'accounts:is-organization-admin' + x-cli-name: accounts:is-organization-admin parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IsAdministrator' + $ref: "#/components/schemas/IsAdministrator" example: admin: true _links: self: - href: 'https://cloud.acquia.com/api/account/organizations/2026962e-2fe4-11e9-b210-d663bd873d93/is-admin' + href: https://cloud.acquia.com/api/account/organizations/2026962e-2fe4-11e9-b210-d663bd873d93/is-admin organization: - href: 'https://cloud.acquia.com/api/organizations/2026962e-2fe4-11e9-b210-d663bd873d93' - '403': + href: https://cloud.acquia.com/api/organizations/2026962e-2fe4-11e9-b210-d663bd873d93 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Do not have permission: value: error: forbidden message: You do not have permission to administer this organization. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/account/organizations/{organizationUuid}/is-owner': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/account/organizations/{organizationUuid}/is-owner": get: tags: - Account summary: Returns whether your account is the owner for an organization. description: Returns whether your account is the owner for an organization. operationId: getAccountOrganizationIsOwner - x-cli-name: 'accounts:is-organization-owner' + x-cli-name: accounts:is-organization-owner parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IsAdministrator' + $ref: "#/components/schemas/IsOwner" example: owner: true _links: self: - href: 'https://cloud.acquia.com/api/account/organizations/2026962e-2fe4-11e9-b210-d663bd873d93/is-owner' + href: https://cloud.acquia.com/api/account/organizations/2026962e-2fe4-11e9-b210-d663bd873d93/is-owner organization: - href: 'https://cloud.acquia.com/api/organizations/2026962e-2fe4-11e9-b210-d663bd873d93' - '404': + href: https://cloud.acquia.com/api/organizations/2026962e-2fe4-11e9-b210-d663bd873d93 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. /account/password: post: tags: @@ -7069,29 +7788,29 @@ paths: summary: Verifies that the supplied password matches the current user's password. description: Verifies that the supplied password matches the current user's password. operationId: postAccountPassword - x-cli-name: 'accounts:password-check' + x-cli-name: accounts:password-check requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/PasswordRequest' + $ref: "#/components/schemas/PasswordRequest" example: password: mysupersecretpassword application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PasswordRequest' + $ref: "#/components/schemas/PasswordRequest" example: password: mysupersecretpassword security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/PasswordValidation' + $ref: "#/components/schemas/PasswordValidation" example: valid: true /account/ssh-keys: @@ -7108,133 +7827,133 @@ paths: Sortable fields: * `label` operationId: getAccountSshKeys - x-cli-name: 'accounts:ssh-keys-list' - parameters: - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + x-cli-name: accounts:ssh-keys-list + parameters: + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SshKeys' + $ref: "#/components/schemas/SshKeys" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/account/ssh-keys' + href: https://cloud.acquia.com/api/account/ssh-keys sort: - href: 'https://cloud.acquia.com/api/account/ssh-keys{?sort}' + href: https://cloud.acquia.com/api/account/ssh-keys{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/account/ssh-keys{?filter}' + href: https://cloud.acquia.com/api/account/ssh-keys{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/account/ssh-keys{?limit}' + href: https://cloud.acquia.com/api/account/ssh-keys{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/account' + href: https://cloud.acquia.com/api/account _embedded: items: - uuid: 02905393-65d7-4bef-873b-24593f73d273 label: PC Home - fingerprint: '5d:23:fb:45:70:df:ef:ad:ca:bf:81:93:cd:50:26:28' + fingerprint: 5d:23:fb:45:70:df:ef:ad:ca:bf:81:93:cd:50:26:28 created_at: '2017-05-09T20:30:35+00:00' public_key: ssh-rsa AAAAB3NzaC1yc2EADHrfHY17SbrmAAABIwAAAQEAklOUpkTIpNLTGK9Tjom/BWDSUGPl+nafzlZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5HDTYW7hdI4yQVkbPppSwg0cda3Pbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com _links: self: - href: 'https://cloud.acquia.com/api/account/ssh-keys/02905393-65d7-4bef-873b-24593f73d273' + href: https://cloud.acquia.com/api/account/ssh-keys/02905393-65d7-4bef-873b-24593f73d273 - uuid: d40833b3-6ea4-4339-9e2c-4b78e700258b label: Laptop Work - fingerprint: '5b:18:fb:50:55:df:cf:d5:bf:ea:81:23:ef:55:22:29' + fingerprint: 5b:18:fb:50:55:df:cf:d5:bf:ea:81:23:ef:55:22:29 created_at: '2017-05-09T20:30:35+00:00' public_key: ssh-rsa 1yc2EAAAABIwbrmTIpNLTGK9Tjom/BWDSUGPl+nafzlHDAAAQEAklOUpkDHrfHY17STYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4pSwg0cda3PbAAAAB3NzaCv7kOdJ/MTyBlWXFCRh9lFX5QVkbPp+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com _links: self: - href: 'https://cloud.acquia.com/api/account/ssh-keys/d40833b3-6ea4-4339-9e2c-4b78e700258b' + href: https://cloud.acquia.com/api/account/ssh-keys/d40833b3-6ea4-4339-9e2c-4b78e700258b - uuid: c40ee264-0023-4f60-815b-d20b44740746 label: PC Work - fingerprint: '7c:s3:ab:30:40:da:cf:c5:bf:ca:31:33:ed:58:23:21' + fingerprint: 7c:s3:ab:30:40:da:cf:c5:bf:ca:31:33:ed:58:23:21 created_at: '2017-05-09T20:30:35+00:00' public_key: ssh-rsa A1yc2EAAAlOUpkDHrfHY17SbrmTIAAAB3NzaCom/BWDSUGPl+nafzlHDTYW7hdI4yQVkbPppSwg0cda3ABIwAAAQEAkPZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5bv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com _links: self: - href: 'https://cloud.acquia.com/api/account/ssh-keys/c40ee264-0023-4f60-815b-d20b44740746' - '404': + href: https://cloud.acquia.com/api/account/ssh-keys/c40ee264-0023-4f60-815b-d20b44740746 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: User not found: value: error: not_found - message: 'The user does not exist, or you do not have access to it.' + message: The user does not exist, or you do not have access to it. post: tags: - Account summary: Installs a new SSH key for the current user. description: Installs a new SSH key for the current user. operationId: postAccountSshKeys - x-cli-name: 'accounts:ssh-key-create' + x-cli-name: accounts:ssh-key-create requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SshKeyRequest' + $ref: "#/components/schemas/SshKeyRequest" example: label: mykey public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQChwPHzTTDKDpSbpa2+d22LcbQmsw92eLsUK3Fmei1fiGDkd34NsYCN8m7lsi3NbvdMS83CtPQPWiCveYPzFs1/hHc4PYj8opD2CNnr5iWVVbyaulCYHCgVv4aB/ojcexg8q483A4xJeF15TiCr/gu34rK6ucTvC/tn/rCwJBudczvEwt0klqYwv8Cl/ytaQboSuem5KgSjO3lMrb6CWtfSNhE43ZOw+UBFBqxIninN868vGMkIv9VY34Pwj54rPn/ItQd6Ef4B0KHHaGmzK0vfP+AK7FxNMoHnj3iYT33KZNqtDozdn5tYyH/bThPebEtgqUn+/w5l6wZIC/8zzvls/127ngHk+jNa0PlNyS2TxhPUK4NaPHIEnnrlp07JEYC4ImcBjaYCWAdcTcUkcJjwZQkN4bGmyO9cjICH98SdLD/HxqzTHeaYDbAX/Hu9HfaBb5dXLWsjw3Xc6hoVnUUZbMQyfgb0KgxDLh92eNGxJkpZiL0VDNOWCxDWsNpzwhLNkLqCvI6lyxiLaUzvJAk6dPaRhExmCbU1lDO2eR0FdSwC1TEhJOT9eDIK1r2hztZKs2oa5FNFfB/IFHVWasVFC9N2h/r/egB5zsRxC9MqBLRBq95NBxaRSFng6ML5WZSw41Qi4C/JWVm89rdj2WqScDHYyAdwyyppWU4T5c9Fmw== example@example.com application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SshKeyRequest' + $ref: "#/components/schemas/SshKeyRequest" example: label: mykey public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQChwPHzTTDKDpSbpa2+d22LcbQmsw92eLsUK3Fmei1fiGDkd34NsYCN8m7lsi3NbvdMS83CtPQPWiCveYPzFs1/hHc4PYj8opD2CNnr5iWVVbyaulCYHCgVv4aB/ojcexg8q483A4xJeF15TiCr/gu34rK6ucTvC/tn/rCwJBudczvEwt0klqYwv8Cl/ytaQboSuem5KgSjO3lMrb6CWtfSNhE43ZOw+UBFBqxIninN868vGMkIv9VY34Pwj54rPn/ItQd6Ef4B0KHHaGmzK0vfP+AK7FxNMoHnj3iYT33KZNqtDozdn5tYyH/bThPebEtgqUn+/w5l6wZIC/8zzvls/127ngHk+jNa0PlNyS2TxhPUK4NaPHIEnnrlp07JEYC4ImcBjaYCWAdcTcUkcJjwZQkN4bGmyO9cjICH98SdLD/HxqzTHeaYDbAX/Hu9HfaBb5dXLWsjw3Xc6hoVnUUZbMQyfgb0KgxDLh92eNGxJkpZiL0VDNOWCxDWsNpzwhLNkLqCvI6lyxiLaUzvJAk6dPaRhExmCbU1lDO2eR0FdSwC1TEhJOT9eDIK1r2hztZKs2oa5FNFfB/IFHVWasVFC9N2h/r/egB5zsRxC9MqBLRBq95NBxaRSFng6ML5WZSw41Qi4C/JWVm89rdj2WqScDHYyAdwyyppWU4T5c9Fmw== example@example.com security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Adding SSH key. _links: self: - href: 'https://cloud.acquia.com/api/account/ssh-keys' + href: https://cloud.acquia.com/api/account/ssh-keys parent: - href: 'https://cloud.acquia.com/api/account' + href: https://cloud.acquia.com/api/account notification: - href: 'https://cloud.acquia.com/api/notifications/5fef247f-3c99-42a2-bb3c-69b32a06e7e9' - '400': + href: https://cloud.acquia.com/api/notifications/5fef247f-3c99-42a2-bb3c-69b32a06e7e9 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Label is invalid: value: error: validation_failed message: - public_key: 'The supplied label is invalid: it may only contain letters, numbers and underscores.' + public_key: "The supplied label is invalid: it may only contain letters, numbers and underscores." Public key must be RSA: value: error: validation_failed message: - public_key: 'The supplied public key type is unsupported: it must be RSA (ssh-rsa).' + public_key: "The supplied public key type is unsupported: it must be RSA (ssh-rsa)." Public key is invalid: value: error: validation_failed @@ -7244,24 +7963,24 @@ paths: value: error: validation_failed message: - public_key: 'The supplied public key type is too short: it must be at least 4096 bits long.' - '404': + public_key: "The supplied public key type is too short: it must be at least 4096 bits long." + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The user does not exist, or you do not have access to it.' - '409': + message: The user does not exist, or you do not have access to it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Key with label already exists: value: @@ -7271,318 +7990,318 @@ paths: value: error: conflict message: An SSH key with this public key already exists for this user. - '/account/ssh-keys/{sshKeyUuid}': + "/account/ssh-keys/{sshKeyUuid}": get: tags: - Account summary: Get an SSH key associated with the currently-logged in user. description: Get an SSH key associated with the currently-logged in user. operationId: getAccountSshKey - x-cli-name: 'accounts:ssh-key-find' + x-cli-name: accounts:ssh-key-find parameters: - - $ref: '#/components/parameters/SshKeyUuid' + - $ref: "#/components/parameters/SshKeyUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SshKey' + $ref: "#/components/schemas/SshKey" example: uuid: b2a53dfb-f4e2-4543-814d-7a9aa3793746 label: PC Home - fingerprint: '8d:13:fb:50:50:da:cf:c5:bf:ca:31:33:ed:51:27:24' + fingerprint: 8d:13:fb:50:50:da:cf:c5:bf:ca:31:33:ed:51:27:24 created_at: '2017-05-09T20:30:35+00:00' public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQChwPHzTTDKDpSbpa2+d22LcbQmsw92eLsUK3Fmei1fiGDkd34NsYCN8m7lsi3NbvdMS83CtPQPWiCveYPzFs1/hHc4PYj8opD2CNnr5iWVVbyaulCYHCgVv4aB/ojcexg8q483A4xJeF15TiCr/gu34rK6ucTvC/tn/rCwJBudczvEwt0klqYwv8Cl/ytaQboSuem5KgSjO3lMrb6CWtfSNhE43ZOw+UBFBqxIninN868vGMkIv9VY34Pwj54rPn/ItQd6Ef4B0KHHaGmzK0vfP+AK7FxNMoHnj3iYT33KZNqtDozdn5tYyH/bThPebEtgqUn+/w5l6wZIC/8zzvls/127ngHk+jNa0PlNyS2TxhPUK4NaPHIEnnrlp07JEYC4ImcBjaYCWAdcTcUkcJjwZQkN4bGmyO9cjICH98SdLD/HxqzTHeaYDbAX/Hu9HfaBb5dXLWsjw3Xc6hoVnUUZbMQyfgb0KgxDLh92eNGxJkpZiL0VDNOWCxDWsNpzwhLNkLqCvI6lyxiLaUzvJAk6dPaRhExmCbU1lDO2eR0FdSwC1TEhJOT9eDIK1r2hztZKs2oa5FNFfB/IFHVWasVFC9N2h/r/egB5zsRxC9MqBLRBq95NBxaRSFng6ML5WZSw41Qi4C/JWVm89rdj2WqScDHYyAdwyyppWU4T5c9Fmw== example@example.com _links: self: - href: 'https://cloud.acquia.com/api/account/ssh-keys/b2a53dfb-f4e2-4543-814d-7a9aa3793746' + href: https://cloud.acquia.com/api/account/ssh-keys/b2a53dfb-f4e2-4543-814d-7a9aa3793746 parent: - href: 'https://cloud.acquia.com/api/account/ssh-keys' - '404': + href: https://cloud.acquia.com/api/account/ssh-keys + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: SSH key missing: value: error: not_found - message: 'The SSH key does not exist, or you do not have permission to access it.' + message: The SSH key does not exist, or you do not have permission to access it. SSH key not found: value: error: not_found - message: 'The SSH key you are trying to access does not exist, or you do not have permission to access it.' + message: The SSH key you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Account summary: Deletes an SSH key. description: Deletes an SSH key. operationId: deleteAccountSshKey - x-cli-name: 'accounts:ssh-key-delete' + x-cli-name: accounts:ssh-key-delete parameters: - - $ref: '#/components/parameters/SshKeyUuid' + - $ref: "#/components/parameters/SshKeyUuid" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Removed key: value: message: Removed SSH key. _links: self: - href: 'https://cloud.acquia.com/api/account/ssh-keys/1acbb1a5-e864-4b8e-a3f9-b1ed462afd25' + href: https://cloud.acquia.com/api/account/ssh-keys/1acbb1a5-e864-4b8e-a3f9-b1ed462afd25 parent: - href: 'https://cloud.acquia.com/api/account/ssh-keys' + href: https://cloud.acquia.com/api/account/ssh-keys notification: - href: 'https://cloud.acquia.com/api/notifications/519caf5f-007a-4562-a726-37624cff7fd8' - '404': + href: https://cloud.acquia.com/api/notifications/519caf5f-007a-4562-a726-37624cff7fd8 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: SSH key missing: value: error: not_found - message: 'The SSH key does not exist, or you do not have permission to access it.' + message: The SSH key does not exist, or you do not have permission to access it. SSH key does not exist: value: error: not_found message: An SSH key with UUID 1df4cb00-2fe9-11e9-b210-d663bd873d93 does not exist. - '/account/subscriptions/{subscriptionUuid}/is-admin': + "/account/subscriptions/{subscriptionUuid}/is-admin": get: tags: - Account summary: Returns whether your account is an administrator for a subscription. description: Returns whether your account is an administrator for a subscription. operationId: getAccountSubscriptionIsAdministrator - x-cli-name: 'accounts:is-subscription-admin' + x-cli-name: accounts:is-subscription-admin parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IsAdministrator' + $ref: "#/components/schemas/IsAdministrator" example: admin: true _links: self: - href: 'https://cloud.acquia.com/api/account/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93/is-admin' + href: https://cloud.acquia.com/api/account/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93/is-admin subscription: - href: 'https://cloud.acquia.com/api/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93' - '403': + href: https://cloud.acquia.com/api/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Do not have permission: value: error: forbidden message: You do not have permission to administer this subscription. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/account/subscriptions/{subscriptionUuid}/is-owner': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/account/subscriptions/{subscriptionUuid}/is-owner": get: tags: - Account summary: Returns whether your account is the owner for a subscription. description: Returns whether your account is the owner for a subscription. operationId: getAccountSubscriptionIsOwner - x-cli-name: 'accounts:is-subscription-owner' + x-cli-name: accounts:is-subscription-owner parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IsOwner' + $ref: "#/components/schemas/IsOwner" example: owner: true _links: self: - href: 'https://cloud.acquia.com/api/account/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93/is-owner' + href: https://cloud.acquia.com/api/account/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93/is-owner subscription: - href: 'https://cloud.acquia.com/api/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93' - '404': + href: https://cloud.acquia.com/api/subscriptions/b7ff7510-2fe4-11e9-b210-d663bd873d93 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/account/teams/{teamUuid}/has-permission': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/account/teams/{teamUuid}/has-permission": get: tags: - Account summary: Returns whether your account has access to a specific team permission. description: Returns whether your account has access to a specific team permission. operationId: getAccountTeamHasPermission - x-cli-name: 'accounts:has-team-permission' + x-cli-name: accounts:has-team-permission parameters: - - $ref: '#/components/parameters/TeamUuid' - - $ref: '#/components/parameters/Permission' + - $ref: "#/components/parameters/TeamUuid" + - $ref: "#/components/parameters/Permission" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/HasPermission' + $ref: "#/components/schemas/HasPermission" example: access: true _links: self: - href: 'https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/has-permission?permission=deploy%20to%20prod' + href: https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/has-permission?permission=deploy%20to%20prod team: - href: 'https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93' - '403': + href: https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Do not have permission: value: error: forbidden message: You do not have the 'example permission' permission for this team. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Team not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. Permission not found: value: error: not_found message: The permission you are trying to look up does not exist. - '/account/teams/{teamUuid}/is-admin': + "/account/teams/{teamUuid}/is-admin": get: tags: - Account summary: Returns whether your account is an administrator for a team. description: Returns whether your account is an administrator for a team. operationId: getAccountTeamIsAdministrator - x-cli-name: 'accounts:is-team-admin' + x-cli-name: accounts:is-team-admin parameters: - - $ref: '#/components/parameters/TeamUuid' + - $ref: "#/components/parameters/TeamUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IsAdministrator' + $ref: "#/components/schemas/IsAdministrator" example: admin: true _links: self: - href: 'https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/is-admin' + href: https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/is-admin team: - href: 'https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93' - '403': + href: https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Do not have permission: value: error: forbidden message: You do not have permission to administer this team. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' - '/account/teams/{teamUuid}/is-owner': + message: The team you are trying to access does not exist, or you do not have permission to access it. + "/account/teams/{teamUuid}/is-owner": get: tags: - Account summary: Returns whether your account is the owner for a team. description: Returns whether your account is the owner for a team. operationId: getAccountTeamIsOwner - x-cli-name: 'accounts:is-team-owner' + x-cli-name: accounts:is-team-owner parameters: - - $ref: '#/components/parameters/TeamUuid' + - $ref: "#/components/parameters/TeamUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IsOwner' + $ref: "#/components/schemas/IsOwner" example: owner: true _links: self: - href: 'https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/is-owner' + href: https://cloud.acquia.com/api/account/teams/e5b32204-2fe4-11e9-b210-d663bd873d93/is-owner team: - href: 'https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93' - '404': + href: https://cloud.acquia.com/api/teams/e5b32204-2fe4-11e9-b210-d663bd873d93 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. /account/tokens: get: tags: @@ -7590,121 +8309,125 @@ paths: summary: Returns a list of metadata for API access tokens tied to your account. description: Returns a list of metadata for API access tokens tied to your account. operationId: getAccountTokens - x-cli-name: 'accounts:tokens-list' + x-cli-name: accounts:tokens-list security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Tokens' + $ref: "#/components/schemas/Tokens" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/account/tokens' + href: https://cloud.acquia.com/api/account/tokens parent: - href: 'https://cloud.acquia.com/api/account' + href: https://cloud.acquia.com/api/account _embedded: items: - uuid: 17feaf34-5d04-402b-9a67-15d5161d24e1 active: true label: My First App created_at: '2016-01-22T17:41:57-0500' + flags: + active: true revocation: null _links: self: - href: 'https://cloud.acquia.com/api/account/tokens/17feaf34-5d04-402b-9a67-15d5161d24e1' + href: https://cloud.acquia.com/api/account/tokens/17feaf34-5d04-402b-9a67-15d5161d24e1 - uuid: 81e8965d-0af0-460d-9e46-977dfcc38c29 active: true label: My Second App created_at: '2016-01-22T17:55:15-0500' + flags: + active: true revocation: null _links: self: - href: 'https://cloud.acquia.com/api/account/tokens/81e8965d-0af0-460d-9e46-977dfcc38c29' - '404': + href: https://cloud.acquia.com/api/account/tokens/81e8965d-0af0-460d-9e46-977dfcc38c29 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: User not found: value: error: not_found - message: 'The user does not exist, or you do not have access to it.' + message: The user does not exist, or you do not have access to it. post: tags: - Account summary: Creates an API access token tied to your account. description: Creates an API access token tied to your account. operationId: postAccountTokens - x-cli-name: 'accounts:token-create' + x-cli-name: accounts:token-create requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/TokenRequest' + $ref: "#/components/schemas/TokenRequest" example: label: API token for My App application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/TokenRequest' + $ref: "#/components/schemas/TokenRequest" example: label: API token for My App security: - OAuth2: [] responses: - '201': + "201": description: Created content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/TokenCreation' + $ref: "#/components/schemas/TokenCreation" example: api_key: 137bd484-dcc8-4950-a784-1f01de7f6378 api_secret: 4DmbUmGiUkafdjcZk2yV6u17jPmmunwt8/47mKdAQIc= _links: self: - href: 'https://cloud.acquia.com/api/account/tokens' + href: https://cloud.acquia.com/api/account/tokens parent: - href: 'https://cloud.acquia.com/api/account' + href: https://cloud.acquia.com/api/account notification: - href: 'https://cloud.acquia.com/api/notifications/ab142771-826e-42b0-a53c-e112b70448d2' - '404': + href: https://cloud.acquia.com/api/notifications/ab142771-826e-42b0-a53c-e112b70448d2 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The user does not exist, or you do not have access to it.' - '/account/tokens/{tokenUuid}': + message: The user does not exist, or you do not have access to it. + "/account/tokens/{tokenUuid}": get: tags: - Account summary: Return details about a specific token. description: Return details about a specific token. operationId: getAccountToken - x-cli-name: 'accounts:token-list' + x-cli-name: accounts:token-list parameters: - - $ref: '#/components/parameters/TokenUuid' + - $ref: "#/components/parameters/TokenUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Token' + $ref: "#/components/schemas/Token" example: uuid: 17feaf34-5d04-402b-9a67-15d5161d24e1 active: true @@ -7715,65 +8438,65 @@ paths: active: true _links: self: - href: 'https://cloud.acquia.com/api/account/tokens/17feaf34-5d04-402b-9a67-15d5161d24e1' + href: https://cloud.acquia.com/api/account/tokens/17feaf34-5d04-402b-9a67-15d5161d24e1 parent: - href: 'https://cloud.acquia.com/api/account/tokens' - '404': + href: https://cloud.acquia.com/api/account/tokens + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Token not found: value: error: not_found - message: 'The access token does not exist, or you do not have permission to access it.' + message: The access token does not exist, or you do not have permission to access it. delete: tags: - Account summary: Revokes an access token. description: Revokes an access token. This action will prevent the access token from being able to authorize access to the API in the future. operationId: deleteAccountToken - x-cli-name: 'accounts:token-delete' + x-cli-name: accounts:token-delete parameters: - - $ref: '#/components/parameters/TokenUuid' - - $ref: '#/components/parameters/TokenDeleteReason' + - $ref: "#/components/parameters/TokenUuid" + - $ref: "#/components/parameters/TokenDeleteReason" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The access token has been revoked. _links: self: - href: 'https://cloud.acquia.com/api/account/tokens/03c86402-5e3b-4212-b6fd-009d271da1d0' + href: https://cloud.acquia.com/api/account/tokens/03c86402-5e3b-4212-b6fd-009d271da1d0 parent: - href: 'https://cloud.acquia.com/api/account/tokens' + href: https://cloud.acquia.com/api/account/tokens notification: - href: 'https://cloud.acquia.com/api/notifications/7815f68b-fc52-4dc8-bdde-04d0960943e9' - '404': + href: https://cloud.acquia.com/api/notifications/7815f68b-fc52-4dc8-bdde-04d0960943e9 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The access token does not exist, or you do not have permission to access it.' - '409': + message: The access token does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already revoked: value: @@ -7786,21 +8509,21 @@ paths: summary: Return a list of agreements. description: Returns a list of agreements you have been invited to accept or decline. operationId: getAgreements - x-cli-name: 'agreements:list' + x-cli-name: agreements:list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Agreements' + $ref: "#/components/schemas/Agreements" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/agreements' + href: https://cloud.acquia.com/api/agreements parent: - href: 'https://cloud.acquia.com/api/' + href: https://cloud.acquia.com/api/ _embedded: items: - uuid: efc62c93-8203-4e8b-a8ff-4d18b780d4ab @@ -7808,14 +8531,14 @@ paths: title: Agreement Title body:

Agreement body and text.

status: accepted - created_at: '2017-01-23T12:00:00Z' - updated_at: '2017-01-27T12:00:00Z' + created_at: 2017-01-23T12:00:00Z + updated_at: 2017-01-27T12:00:00Z actioned_by: uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 first_name: James last_name: Kirk mail: james.kirk@example.com - picture_url: 'https://accounts.acquia.com/sites/default/avatars/456def?mail=james.kirk@example.com' + picture_url: https://accounts.acquia.com/sites/default/avatars/456def?mail=james.kirk@example.com username: james.kirk reference: uuid: 9ab09eba-290d-4ed9-be4d-fa194ab92f39 @@ -7823,19 +8546,20 @@ paths: type: subscription _links: self: - href: 'https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab' + href: https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab - uuid: b63fff64-6c18-4899-acba-00ec6c8930e9 + document_uuid: 20370a6e-9b82-4580-8769-886f5f6c8693 title: Another Agreement body:

This is the body and text of another agreement.

status: declined - created_at: '2017-02-23T12:00:00Z' - updated_at: '2017-02-27T12:00:00Z' + created_at: 2017-02-23T12:00:00Z + updated_at: 2017-02-27T12:00:00Z actioned_by: uuid: 550e8400-e29b-41d4-a716-446655440000 first_name: Jane last_name: Doe mail: jane.doe@example.com - picture_url: 'https://accounts.acquia.com/sites/default/avatars/123abc?mail=jane.doe@example.com' + picture_url: https://accounts.acquia.com/sites/default/avatars/123abc?mail=jane.doe@example.com username: jane.doe reference: uuid: 9ab09eba-290d-4ed9-be4d-fa194ab92f39 @@ -7843,12 +8567,13 @@ paths: type: subscription _links: self: - href: 'https://cloud.acquia.com/api/agreements/b63fff64-6c18-4899-acba-00ec6c8930e9' + href: https://cloud.acquia.com/api/agreements/b63fff64-6c18-4899-acba-00ec6c8930e9 - uuid: a8777880-8924-494a-abe2-62cc092df269 + document_uuid: 466c62ef-5ced-400d-b328-d47e745b50a8 title: A Third Agreement body:

This is the body and text of one more agreement.

status: pending - created_at: '2017-02-23T12:00:00Z' + created_at: 2017-02-23T12:00:00Z updated_at: null actioned_by: null reference: @@ -7857,49 +8582,49 @@ paths: type: subscription _links: self: - href: 'https://cloud.acquia.com/api/agreements/a8777880-8924-494a-abe2-62cc092df269' - '404': + href: https://cloud.acquia.com/api/agreements/a8777880-8924-494a-abe2-62cc092df269 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The agreement you are trying to access does not exist, or you do not have permission to access it.' - '/agreements/{agreementUuid}': + message: The agreement you are trying to access does not exist, or you do not have permission to access it. + "/agreements/{agreementUuid}": get: tags: - Agreements summary: Return a specific agreement by a provided UUID. description: Return a specific agreement. operationId: getAgreement - x-cli-name: 'agreements:find' + x-cli-name: agreements:find parameters: - - $ref: '#/components/parameters/AgreementUuid' + - $ref: "#/components/parameters/AgreementUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Agreement' + $ref: "#/components/schemas/Agreement" example: uuid: efc62c93-8203-4e8b-a8ff-4d18b780d4ab document_uuid: f25d0284-f25f-4e59-9c48-7c39ae57b400 title: Agreement Title body:

Agreement body and text.

status: accepted - created_at: '2017-01-23T12:00:00Z' - updated_at: '2017-01-27T12:00:00Z' + created_at: 2017-01-23T12:00:00Z + updated_at: 2017-01-27T12:00:00Z actioned_by: uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 first_name: James last_name: Kirk mail: james.kirk@example.com - picture_url: 'https://accounts.acquia.com/sites/default/avatars/456def?mail=james.kirk@example.com' + picture_url: https://accounts.acquia.com/sites/default/avatars/456def?mail=james.kirk@example.com username: james.kirk reference: uuid: 9ab09eba-290d-4ed9-be4d-fa194ab92f39 @@ -7907,162 +8632,162 @@ paths: type: subscription _links: self: - href: 'https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab' + href: https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab invitees: - href: 'https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab/invitees' + href: https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab/invitees subscription: - href: 'https://cloud.acquia.com/api/subscriptions/9ab09eba-290d-4ed9-be4d-fa194ab92f39' + href: https://cloud.acquia.com/api/subscriptions/9ab09eba-290d-4ed9-be4d-fa194ab92f39 actioned_by: - href: 'https://cloud.acquia.com/api/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3' + href: https://cloud.acquia.com/api/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 parent: - href: 'https://cloud.acquia.com/api/agreements' - '404': + href: https://cloud.acquia.com/api/agreements + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The agreement you are trying to access does not exist, or you do not have permission to access it.' - '/agreements/{agreementUuid}/actions/accept': + message: The agreement you are trying to access does not exist, or you do not have permission to access it. + "/agreements/{agreementUuid}/actions/accept": post: tags: - Agreements summary: Accepts a legal agreement by UUID. description: Accepts a legal agreement. operationId: postAcceptAgreement - x-cli-name: 'agreements:accept' + x-cli-name: agreements:accept parameters: - - $ref: '#/components/parameters/AgreementUuid' + - $ref: "#/components/parameters/AgreementUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: The agreement has been accepted. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The agreement you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The agreement you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already acted upon: value: error: conflict message: This agreement has already been acted upon. - '/agreements/{agreementUuid}/actions/decline': + "/agreements/{agreementUuid}/actions/decline": post: tags: - Agreements summary: Declines a legal agreement by UUID. description: Declines a legal agreement. operationId: postDeclineAgreement - x-cli-name: 'agreements:decline' + x-cli-name: agreements:decline parameters: - - $ref: '#/components/parameters/AgreementUuid' + - $ref: "#/components/parameters/AgreementUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: The agreement has been declined. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The agreement you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The agreement you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already acted upon: value: error: conflict message: This agreement has already been acted upon. - '/agreements/{agreementUuid}/invitees': + "/agreements/{agreementUuid}/invitees": get: tags: - Agreements summary: Returns a list of users invited to action this agreement. description: Returns a list of users invited to action this agreement by UUID. operationId: getInvitees - x-cli-name: 'agreements:invitees-list' + x-cli-name: agreements:invitees-list parameters: - - $ref: '#/components/parameters/AgreementUuid' + - $ref: "#/components/parameters/AgreementUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Invitees' + $ref: "#/components/schemas/Invitees" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab/invitees' + href: https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab/invitees parent: - href: 'https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab' + href: https://cloud.acquia.com/api/agreements/efc62c93-8203-4e8b-a8ff-4d18b780d4ab _embedded: items: - - uuid: u4ee550f-ee0c-102e-8305-1231390f2cc1 + - uuid: 6188cbcf-b176-4554-b17e-fbd8119ef46d first_name: User last_name: One mail: user1@example.com username: user.one - picture_url: 'https://accounts.acquia.com/path/to/image.png' - - uuid: u4ef8edc-ee0c-102e-8305-1231390f2cc2 + picture_url: https://accounts.acquia.com/path/to/image.png + - uuid: 099a8a59-88d6-48c2-a121-ef29431f4aba first_name: User last_name: Two mail: user2@example.com username: user.two - picture_url: 'https://accounts.acquia.com/path/to/image.png' - '404': + picture_url: https://accounts.acquia.com/path/to/image.png + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The agreement you are trying to access does not exist, or you do not have permission to access it.a' + message: The agreement you are trying to access does not exist, or you do not have permission to access it.a /applications: get: tags: - Applications summary: Return a list of applications the current user has access to. operationId: getApplications - x-cli-name: 'applications:list' + x-cli-name: applications:list security: - OAuth2: [] description: | @@ -8079,17 +8804,17 @@ paths: * `name` (Deprecated) * `organization_name` parameters: - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Applications' + $ref: "#/components/schemas/Applications" example: total: 2 pagination: @@ -8098,18 +8823,18 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/applications?limit=10' + href: https://cloud.acquia.com/api/applications?limit=10 sort: - href: 'https://cloud.acquia.com/api/applications{?sort}' + href: https://cloud.acquia.com/api/applications{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications{?filter}' + href: https://cloud.acquia.com/api/applications{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/applications{?limit}' + href: https://cloud.acquia.com/api/applications{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/' + href: https://cloud.acquia.com/api/ _embedded: items: - id: 241643 @@ -8117,7 +8842,7 @@ paths: name: Sample application 1 hosting: type: acp - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470 name: Sample subscription @@ -8130,28 +8855,28 @@ paths: type: drupal _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 tags: - name: tag-1 color: blue _links: self: - href: 'https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1' + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1 parent: - href: 'https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags' + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - name: tag-2 color: green _links: self: - href: 'https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2' + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2 parent: - href: 'https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags' + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - id: 954291 uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471 name: Sample application 2 hosting: type: free - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470 name: Sample subscription @@ -8164,59 +8889,59 @@ paths: status: provisioning _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471 tags: - name: tag-1 color: blue _links: self: - href: 'https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1' + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1 parent: - href: 'https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags' + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - name: tag-2 color: green _links: self: - href: 'https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2' + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2 parent: - href: 'https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags' - '403': + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: forbidden message: You do not have permission to view applications. - '/applications/{applicationUuid}': + "/applications/{applicationUuid}": get: tags: - Applications summary: Return details about a specific application. operationId: getApplicationByUuid - x-cli-name: 'applications:find' + x-cli-name: applications:find security: - OAuth2: [] description: A specific application. parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Application' + $ref: "#/components/schemas/Application" example: id: 2416431 uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470 name: Sample application hosting: type: acp - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470 name: Sample subscription @@ -8229,83 +8954,83 @@ paths: status: normal _links: self: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a code: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/code' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/code databases: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases environments: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/environments' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/environments events: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/events' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/events features: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/features' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/features ides: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/ides' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/ides permissions: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/permissions' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/permissions search: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/search' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/search settings: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings tasks: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks teams: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/teams' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/teams parent: - href: 'https://cloud.acquia.com/api/applications' + href: https://cloud.acquia.com/api/applications _embedded: subscription: uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470 name: Sample subscription _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d470 organization: uuid: 6a907396-abfd-4d01-9da6-64c8efc04519 name: Sample organization _links: self: - href: 'https://cloud.acquia.com/api/organizations/6a907396-abfd-4d01-9da6-64c8efc04519' + href: https://cloud.acquia.com/api/organizations/6a907396-abfd-4d01-9da6-64c8efc04519 tags: - name: tag-1 color: blue _links: self: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1 + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1 parent: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - name: tag-2 color: green _links: self: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2 + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2 parent: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - '404': + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. put: tags: - Applications summary: Renames an application. operationId: putApplicationByUuid - x-cli-name: 'applications:rename' + x-cli-name: applications:rename security: - OAuth2: [] description: Renames a specific application. parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -8326,48 +9051,48 @@ paths: example: name: My new application name responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Application renamed. _links: self: - href: 'https://cloud.acquia.com/api/applications/db1d0e46-6799-4208-9786-c7e64150a7c7' + href: https://cloud.acquia.com/api/applications/db1d0e46-6799-4208-9786-c7e64150a7c7 parent: - href: 'https://cloud.acquia.com/api/applications' + href: https://cloud.acquia.com/api/applications notification: - href: 'https://cloud.acquia.com/api/notifications/27698331-bcf9-48e9-9f12-931ac88f446f' - '400': + href: https://cloud.acquia.com/api/notifications/27698331-bcf9-48e9-9f12-931ac88f446f + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Name already in use: value: error: validation_failed message: name: You already have an application with this name. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to modify this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application: value: @@ -8376,25 +9101,25 @@ paths: No application or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Name in use: value: error: conflict message: The new application name is the same as the old application name. No action taken. - '/applications/{applicationUuid}/artifacts': + "/applications/{applicationUuid}/artifacts": get: tags: - Applications summary: Return application artifacts. operationId: getArtifactsByApplicationUuid - x-cli-name: 'applications:artifact-list' + x-cli-name: applications:artifact-list security: - OAuth2: [] description: | @@ -8408,33 +9133,33 @@ paths: * `created` * `name` parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Artifacts' + $ref: "#/components/schemas/Artifacts" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts parent: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 sort: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?sort}' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?filter}' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?limit}' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts{?limit} templated: true _embedded: items: @@ -8444,55 +9169,55 @@ paths: created_at: '2012-05-15T12:00:00Z' _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1 - id: 2 name: master@a265389db6a6918cf4e51edbe5f06d7e1578175c state: pending-upload created_at: '2012-05-15T12:00:00Z' _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/2' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/2 - id: 3 name: master@e7157f36e5fb82317ffee2fc2d70302cdad0c60c state: deleted created_at: '2012-05-15T12:00:00Z' _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/3' - '404': + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/3 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. Application type: value: error: not_found message: Artifacts are only available for Node.js applications. - '/applications/{applicationUuid}/artifacts/{artifactId}': + "/applications/{applicationUuid}/artifacts/{artifactId}": get: tags: - Applications summary: Return details about a specific artifact. operationId: getArtifactByApplicationUuidAndId - x-cli-name: 'applications:artifact-find' + x-cli-name: applications:artifact-find description: | A specific artifact. parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/ArtifactId' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/ArtifactId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Artifact' + $ref: "#/components/schemas/Artifact" example: id: 1 name: master@e5a80b9e0a2bdb1df32c6cdfce54deb70cc20ad2 @@ -8500,15 +9225,15 @@ paths: created_at: '2012-05-15T12:00:00Z' _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1 parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts' - '404': + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application: value: @@ -8517,22 +9242,22 @@ paths: No application or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. No artifact: value: error: not_found - message: 'The build artifact you are trying to access does not exist, or you do not have permission to access it.' + message: The build artifact you are trying to access does not exist, or you do not have permission to access it. Application type: value: error: not_found message: Artifacts are only available for Node.js applications. - '/applications/{applicationUuid}/code': + "/applications/{applicationUuid}/code": get: tags: - Applications summary: Return application branches and release tags. operationId: getCodeByApplicationUuid - x-cli-name: 'applications:vcs-info' + x-cli-name: applications:vcs-info security: - OAuth2: [] description: | @@ -8544,23 +9269,23 @@ paths: Sortable fields: * `name` parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Code' + $ref: "#/components/schemas/Code" example: total: 4 _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/code' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/code parent: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 _embedded: items: - name: master @@ -8575,97 +9300,256 @@ paths: - name: tags/2014-09-03.0 flags: tag: true - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No VCS Settings: value: error: not_found message: No version control system settings found on non-hosted application. - '/applications/{applicationUuid}/databases': + "/applications/{applicationUuid}/code-studio": get: tags: - Applications - summary: Returns a list database names for the application. - description: | - Filterable fields: - * `name` - - Sortable fields: - * `name` - operationId: getApplicationDatabases - x-cli-name: 'applications:database-list' + summary: Returns details about the Code Studio project for an application. + description: Return details about the Code Studio project for an application. + operationId: getCodeStudioProject + security: + - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/ApplicationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationDatabases' + $ref: "#/components/schemas/CodeStudioProject" example: - total: 2 _links: self: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases' - sort: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?sort}' - templated: true - filter: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?filter}' - templated: true - limit: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?limit}' - templated: true + href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c/code-studio + application: + href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c parent: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a' + href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c + applications: + href: https://cloud.acquia.com/api/applications + code-studio: + href: https://code.acquia.com/path/to/project + code-studio-api: + href: https://code.acquia.com/api/v4/path/to/project _embedded: - items: - - name: database1 - - name: database2 - '404': - description: Not Found + application: + _links: + self: + href: https://cloud.acquia.com/api/applications/906c1ad5-f367-4127-b529-9dbe29bc5c1c + uuid: 906c1ad5-f367-4127-b529-9dbe29bc5c1c + name: My Application + application_id: 906c1ad5-f367-4127-b529-9dbe29bc5c1c + status: active + "403": + description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: - No data or permission: + No entitlement: value: - error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - Not available on Node.js: + error: forbidden + message: Code Studio is not available for this application. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No application or permission: value: error: not_found - message: Databases do not exist on Node.js applications. - Non-hosted application: + message: The application you are trying to access does not exist, or you do not have permission to access it. + Code Studio not enabled for application: value: error: not_found - message: Databases do not exist on non-hosted applications. + message: Code Studio is not enabled for this application. post: tags: - Applications - summary: Creates a database. - description: This action will create a new database within each environment of the application. - operationId: postApplicationDatabaseCreate - x-cli-name: 'applications:database-create' + summary: Creates the Code Studio project for an application. + description: Creates the Code Studio project for an application. + operationId: postCodeStudioProject security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' - requestBody: + - $ref: "#/components/parameters/ApplicationUuid" + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/MessageWithLinks" + example: + _links: + self: + href: https://cloud.acquia.com/api/applications/98529a07-5f07-4c4d-836b-03c9226c03fd/code-studio + notification: + href: https://cloud.acquia.com/api/notifications/e0c0ec4d-cb4d-4b9a-92ed-503d1e8dae4a + message: A Code Studio project is being created for the Application. + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No permission: + value: + error: forbidden + message: You do not have permission to create a Code Studio project for this Application. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No application or permission: + value: + error: not_found + message: The application you are trying to access does not exist, or you do not have permission to access it. + delete: + tags: + - Applications + summary: Removes the Code Studio project from an application. + description: Removes the Code Studio project from an application. + operationId: deleteCodeStudioProject + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/ApplicationUuid" + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/MessageWithLinks" + example: + _links: + self: + href: https://cloud.acquia.com/api/applications/98529a07-5f07-4c4d-836b-03c9226c03fd/code-studio + notification: + href: https://cloud.acquia.com/api/notifications/e0c0ec4d-cb4d-4b9a-92ed-503d1e8dae4a + message: The Code Studio project is being removed from the Application. + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No permission: + value: + error: forbidden + message: You do not have permission to remove the Code Studio project from this Application. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No application or permission: + value: + error: not_found + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/databases": + get: + tags: + - Applications + summary: Returns a list database names for the application. + description: | + Filterable fields: + * `name` + + Sortable fields: + * `name` + operationId: getApplicationDatabases + x-cli-name: applications:database-list + parameters: + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/ApplicationDatabases" + example: + total: 2 + _links: + self: + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases + sort: + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?sort} + templated: true + filter: + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?filter} + templated: true + limit: + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/databases{?limit} + templated: true + parent: + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a + _embedded: + items: + - name: database1 + - name: database2 + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No data or permission: + value: + error: not_found + message: The application you are trying to access does not exist, or you do not have permission to access it. + Not available on Node.js: + value: + error: not_found + message: Databases do not exist on Node.js applications. + Non-hosted application: + value: + error: not_found + message: Databases do not exist on non-hosted applications. + post: + tags: + - Applications + summary: Creates a database. + description: This action will create a new database within each environment of the application. + operationId: postApplicationDatabaseCreate + x-cli-name: applications:database-create + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/ApplicationUuid" + requestBody: required: true content: - application/json: + application/hal+json: schema: type: object description: Application database name. @@ -8694,33 +9578,33 @@ paths: example: name: my_db_name responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The database is being created. _links: self: - href: 'https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/databases' + href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/databases notification: - href: 'https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69' + href: https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69 parent: - href: 'https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1' - '400': + href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Only available for hosted applications: value: error: validation_failed @@ -8751,12 +9635,12 @@ paths: error: validation_failed message: name: A database with that name already exists. Please choose another name. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: @@ -8774,52 +9658,52 @@ paths: value: error: forbidden message: Databases cannot be added on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/databases/{name}': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/databases/{name}": delete: tags: - Applications summary: Drops (deletes) a database. description: This action will delete the database in ALL environments within this application. operationId: postApplicationDatabaseDelete - x-cli-name: 'applications:database-delete' + x-cli-name: applications:database-delete security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Name' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Name" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The database is being deleted. _links: self: - href: 'https://cloud.acquia.com/api/applications/f75e226b-2d8c-48c7-b3a7-614bb440272d/databases/testdatabase' + href: https://cloud.acquia.com/api/applications/f75e226b-2d8c-48c7-b3a7-614bb440272d/databases/testdatabase notification: - href: 'https://cloud.acquia.com/api/notifications/a90295b6-f50f-4670-8ca4-bb936a55c3a3' + href: https://cloud.acquia.com/api/notifications/a90295b6-f50f-4670-8ca4-bb936a55c3a3 parent: - href: 'https://cloud.acquia.com/api/applications/f75e226b-2d8c-48c7-b3a7-614bb440272d/databases' - '400': + href: https://cloud.acquia.com/api/applications/f75e226b-2d8c-48c7-b3a7-614bb440272d/databases + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Can only be erased on hosted applications: value: @@ -8835,18 +9719,18 @@ paths: value: error: validation_failed message: - name: 'The database does not belong to this application, and cannot be removed.' + name: The database does not belong to this application, and cannot be removed. Cannot delete default: value: error: validation_failed message: - name: 'The database is a default database, and cannot be removed.' - '403': + name: The database is a default database, and cannot be removed. + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: @@ -8864,52 +9748,52 @@ paths: value: error: forbidden message: Databases cannot be erased on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/databases/{name}/actions/erase': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/databases/{name}/actions/erase": post: tags: - Applications summary: Erases (truncates) a database. description: This action will delete all tables of the database in ALL environments within this application. operationId: postApplicationDatabaseErase - x-cli-name: 'applications:database-erase' + x-cli-name: applications:database-erase security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Name' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Name" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The database is being erased. _links: self: - href: 'https://cloud.acquia.com/api/applications/da1c0a8e-ff69-45db-88fc-acd6d2affbb7/databases/test_database/actions/erase' + href: https://cloud.acquia.com/api/applications/da1c0a8e-ff69-45db-88fc-acd6d2affbb7/databases/test_database/actions/erase notification: - href: 'https://cloud.acquia.com/api/notifications/a90295b6-f50f-4670-8ca4-bb936a55c3a3' + href: https://cloud.acquia.com/api/notifications/a90295b6-f50f-4670-8ca4-bb936a55c3a3 parent: - href: 'https://cloud.acquia.com/api/applications/da1c0a8e-ff69-45db-88fc-acd6d2affbb7/databases/test_database/actions' - '400': + href: https://cloud.acquia.com/api/applications/da1c0a8e-ff69-45db-88fc-acd6d2affbb7/databases/test_database/actions + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Can only be erased on hosted applications: value: @@ -8925,13 +9809,13 @@ paths: value: error: validation_failed message: - name: 'The database does not belong to this application, and cannot be removed.' - '403': + name: The database does not belong to this application, and cannot be removed. + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: ACF only: value: @@ -8953,38 +9837,38 @@ paths: value: error: forbidden message: Databases cannot be erased on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/email/domains': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/email/domains": get: tags: - Applications summary: Returns a list of email domains associated with the application. description: Returns a list of email domains associated with the application and domains that have been verified at the subscription level. operationId: getApplicationEmailDomains - x-cli-name: 'applications:email-domains-list' + x-cli-name: applications:email-domains-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/EmailDomains' + $ref: "#/components/schemas/EmailDomains" example: total: 2 pagination: @@ -8993,20 +9877,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains parent: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email limit: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?limit}' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/applications123e4567-e89b-12d3-a456-426614174000/email/domains{?offset}' + href: https://cloud.acquia.com/api/applications123e4567-e89b-12d3-a456-426614174000/email/domains{?offset} templated: true sort: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?sort}' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?filter}' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/email/domains{?filter} templated: true _embedded: items: @@ -9015,87 +9899,87 @@ paths: flags: associated: true health: - code: '200' - details: '' + code: "200" + details: "" summary: OK - uuid: 123e4567-e89b-12d3-a456-426614174000 domain_name: example2.com flags: associated: true health: - code: '200' - details: '' + code: "200" + details: "" summary: OK - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to manage email domains for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No data or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate": post: tags: - Applications summary: Associates an email domain with an Application. description: Associates an email domain with an Application. operationId: postApplicationAssociateEmailDomain - x-cli-name: 'applications:post-associate-email-domain' + x-cli-name: applications:post-associate-email-domain parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/DomainRegistrationUuid' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/DomainRegistrationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Associate Domain: value: message: The domain has been associated with the application. _links: self: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains//123e4567-e89b-12d3-a456-426614174000/actions/associate' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains//123e4567-e89b-12d3-a456-426614174000/actions/associate parent: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains//123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains//123e4567-e89b-12d3-a456-426614174000 notification: - href: 'https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000' - '403': + href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to associate domains with this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: @@ -9105,12 +9989,12 @@ paths: value: error: not_found message: The domain registration you are trying to associate does not exist or you do not have permission to access it. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No entitlement: value: @@ -9120,54 +10004,54 @@ paths: value: error: conflict message: The domain example.com is already associated with this application. - '/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate': + "/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate": post: tags: - Applications summary: Disassociates an email domain with an Application. description: Disassociates an email domain with an Application. operationId: postApplicationDisassociateEmailDomain - x-cli-name: 'applications:post-disassociate-email-domains' + x-cli-name: applications:post-disassociate-email-domains parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/DomainRegistrationUuid' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/DomainRegistrationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Disassociate Domain: value: message: The domain has been disassociated from the application. _links: self: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000/actions/dissasociate' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000/actions/dissasociate parent: - href: 'https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/applications/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000 notification: - href: 'https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000' - '403': + href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to disassociate domains from this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: @@ -9177,12 +10061,12 @@ paths: value: error: not_found message: The domain registration you are trying to disassociate does not exist or you do not have permission to access it. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Domain minimum: value: @@ -9196,43 +10080,44 @@ paths: value: error: conflict message: The domain example.com is not associated with this application. - '/applications/{applicationUuid}/ides': + "/applications/{applicationUuid}/ides": get: tags: - Applications summary: Returns a list of Cloud IDEs associated with this application. description: Returns a list of Cloud IDEs associated with this application. operationId: getApplicationIdes - x-cli-name: 'applications:ide-list' + x-cli-name: applications:ide-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Ides' + $ref: "#/components/schemas/Ides" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/applications/feea197a-9503-4441-9f49-b4d420b0ecf8/ides' + href: https://cloud.acquia.com/api/applications/feea197a-9503-4441-9f49-b4d420b0ecf8/ides parent: - href: 'https://cloud.acquia.com/api/applications/feea197a-9503-4441-9f49-b4d420b0ecf8' + href: https://cloud.acquia.com/api/applications/feea197a-9503-4441-9f49-b4d420b0ecf8 _embedded: items: - uuid: 9a83c081-ef78-4dbd-8852-11cc3eb248f7 label: IDE Label 1 + status: active _links: self: - href: 'https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7' + href: https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7 web: - href: 'https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud' + href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud ide: - href: 'https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ides.acquia.com' + href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ides.acquia.com application: - href: 'https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199' + href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199 _embedded: owner: uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd @@ -9241,19 +10126,20 @@ paths: last_login_at: '2019-01-31T10:53:11-05:00' created_at: '2016-08-14T17:38:59-04:00' email: user.name@example.com - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name - uuid: feea197a-9503-4441-9f49-b4d420b0ecf8 label: IDE Label 2 + status: active _links: self: - href: 'https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8' + href: https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8 web: - href: 'https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud' + href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud ide: - href: 'https://feea197a-9503-4441-9f49-b4d420b0ecf8.ides.acquia.com' + href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.ides.acquia.com application: - href: 'https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199' + href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199 _embedded: owner: uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd @@ -9262,32 +10148,32 @@ paths: last_login_at: '2019-01-31T10:53:11-05:00' created_at: '2016-08-14T17:38:59-04:00' email: user.name@example.com - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. post: tags: - Applications summary: Creates a new Cloud IDE. description: Creates a new Cloud IDE. operationId: postApplicationsIde - x-cli-name: 'ide:create' + x-cli-name: ide:create parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -9316,47 +10202,47 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: IDE created: value: message: The Cloud IDE is being created. _links: self: - href: 'https://cloud.acquia.com/api/ides/1792767d-1ee3-4b5f-83a8-334dfdc2b8a3' + href: https://cloud.acquia.com/api/ides/1792767d-1ee3-4b5f-83a8-334dfdc2b8a3 parent: - href: 'https://cloud.acquia.com/api/ides' + href: https://cloud.acquia.com/api/ides notification: - href: 'https://cloud.acquia.com/api/notifications/e47da6d7-371e-4bb9-a7fe-d9ab8aa899c3' - '400': + href: https://cloud.acquia.com/api/notifications/e47da6d7-371e-4bb9-a7fe-d9ab8aa899c3 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Bad IDE label: value: error: validation_error message: name: A Cloud IDE labeled My new IDE already exists. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No user: value: error: not_found - message: 'The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/messages': + message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/messages": get: tags: - Applications @@ -9372,43 +10258,43 @@ paths: * `message_type` * `display_mode` operationId: getApplicationMessages - x-cli-name: 'applications:message-list' + x-cli-name: applications:message-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/UxMessages' + $ref: "#/components/schemas/UxMessages" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages' + href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages sort: - href: 'https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?sort}' + href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?filter}' + href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?limit}' + href: https://cloud.acquia.com/api/applications/a838f9a8-11e2-c374-6954-6931d150b259/messages{?limit} templated: true _embedded: items: - - id: '123' + - id: 123 uuid: 77fedb64-b8c0-4712-90e3-f39b4716e623 title: IPM Title body: This is the body of the IPM. - url: 'http://www.acquia.com' + url: http://www.acquia.com filters: paths: - /some/random/path @@ -9420,22 +10306,22 @@ paths: dismissible: true active: true weight: -1 - start_at: '2015-11-05T00:30:00-05:00' - expire_at: '2015-12-05T13:30:00-05:00' + start_at: 2015-11-05T00:30:00-05:00 + expire_at: 2015-12-05T13:30:00-05:00 _links: self: - href: 'https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623' + href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623 dismiss: - href: 'https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623/actions/dismiss' + href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623/actions/dismiss follow: - href: 'https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623/actions/follow' - - id: '234' + href: https://cloud.acquia.com/api/messages/77fedb64-b8c0-4712-90e3-f39b4716e623/actions/follow + - id: 234 uuid: c5328e00-282a-4bec-a3c8-4322d97545b2 title: IPM Message 2 body: IPM Message 2 body - url: 'http://www.google.ca' + url: http://www.google.ca filters: - paths: null + paths: [] display_mode: bar type: new flags: @@ -9443,27 +10329,27 @@ paths: dismissible: true active: true weight: 0 - start_at: '2015-11-07T17:30:00-05:00' - expire_at: '2016-11-07T17:30:00-05:00' + start_at: 2015-11-07T17:30:00-05:00 + expire_at: 2016-11-07T17:30:00-05:00 _links: self: - href: 'https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2' + href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2 dismiss: - href: 'https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2/actions/dismiss' + href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2/actions/dismiss follow: - href: 'https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2/actions/follow' - '404': + href: https://cloud.acquia.com/api/messages/c5328e00-282a-4bec-a3c8-4322d97545b2/actions/follow + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or permission: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/notifications': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/notifications": get: tags: - Applications @@ -9489,20 +10375,20 @@ paths: * `created_at` * `completed_at` operationId: getApplicationNotifications - x-cli-name: 'applications:notification-list' + x-cli-name: applications:notification-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationsNotifications' + $ref: "#/components/schemas/ApplicationsNotifications" example: total: 1 pagination: @@ -9511,20 +10397,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications' + href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications parent: - href: 'https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1' + href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1 limit: - href: 'https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?limit}' + href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?offset}' + href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?offset} templated: true sort: - href: 'https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?sort}' + href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?filter}' + href: https://cloud.acquia.com/api/applications/a027502b-ad6c-a48e-a7e8-aa0def7d25e1/notifications{?filter} templated: true _embedded: items: @@ -9546,18 +10432,23 @@ paths: application: uuids: - a027502b-ad6c-a48e-a7e8-aa0def7d25e1 - '404': + _links: + self: + href: https://cloud.acquia.com/api/notifications/1bd3487e-71d1-4fca-a2d9-5f969b3d35c1 + parent: + href: https://cloud.acquia.com/api/notifications + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/notifications/{notificationUuid}': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/notifications/{notificationUuid}": get: tags: - Applications @@ -9565,19 +10456,19 @@ paths: description: Returns a single notification. This could be either an event or a task. deprecated: true operationId: getApplicationNotificationByUuid - x-cli-name: 'applications:notification-find' + x-cli-name: applications:notification-find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/NotificationUuid' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/NotificationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Notification' + $ref: "#/components/schemas/NotificationDeprecated" example: progress: 100 user: @@ -9585,15 +10476,15 @@ paths: first_name: James last_name: Kirk mail: james.kirk@example.com - picture_url: 'https://accounts.acquia.com/path/to/imagepng' + picture_url: https://accounts.acquia.com/path/to/imagepng username: james.kirk uuid: 63098518-0da8-4e41-943b-1198e3614f38 name: OperationStarted title: Operation title description: Operation description. - created_at: '2017-04-04T17:21:53-04:00' - started_at: '2017-04-04T17:21:53-04:00' - completed_at: '2017-04-04T17:21:59-04:00' + created_at: 2017-04-04T17:21:53-04:00 + started_at: 2017-04-04T17:21:53-04:00 + completed_at: 2017-04-04T17:21:59-04:00 status: completed type: task metadata: @@ -9606,54 +10497,54 @@ paths: reference_uuid: 53098518-0da8-4e41-943b-1198e3614f38 _links: self: - href: 'https://cloud.acquia.com/api/applications/0c7e79ab-1c4a-424e-8446-76ae8be7e851/notifications/123821' - '404': + href: https://cloud.acquia.com/api/applications/0c7e79ab-1c4a-424e-8446-76ae8be7e851/notifications/123821 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No data or permission: value: error: not_found - message: 'The data you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/permissions': + message: The data you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/permissions": get: tags: - Applications summary: Returns a list of permissions the user has for this application by its UUID. description: Returns a list of permissions the user has for this application. operationId: getApplicationPermissions - x-cli-name: 'applications:permission-list' + x-cli-name: applications:permission-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationsPermissions' + $ref: "#/components/schemas/ApplicationsPermissions" example: total: 49 flags: administrator: false _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/permissions' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/permissions parent: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 _embedded: items: - name: deploy to non-prod - label: 'Pull and deploy code, files, or databases to non-production environments' + label: Pull and deploy code, files, or databases to non-production environments description: Grants the ability to enable or disable live development and non-production work. group_label: Workflow flags: deprecated: false - name: deploy to prod - label: 'Deploy code, files, or databases to the production environment' + label: Deploy code, files, or databases to the production environment description: null group_label: Workflow flags: @@ -9797,7 +10688,7 @@ paths: flags: deprecated: false - name: view database connection - label: 'View database connection details (username, password, or hostname)' + label: View database connection details (username, password, or hostname) description: null group_label: Databases flags: @@ -9874,12 +10765,6 @@ paths: group_label: Support flags: deprecated: false - - name: administer ssh keys - label: Manage SSH keys - description: Grants the ability to use SSH and bypass all other permissions via command line tools. - group_label: SSH keys - flags: - deprecated: false - name: view build plans label: View Build plans description: null @@ -9940,85 +10825,85 @@ paths: group_label: Workflow flags: deprecated: false - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/search': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/search": get: tags: - Applications summary: Returns a traversal endpoint for search entities for the application. description: Does not return any data. Allows traversal to search entity endpoints. operationId: getApplicationSearchList - x-cli-name: 'applications:search:list' + x-cli-name: applications:search:list parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Search' + $ref: "#/components/schemas/Search" example: _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905 config-sets: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' - '403': + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Forbidden: value: error: forbidden message: You do not have permission to manage search for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/search/config-sets': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/search/config-sets": get: tags: - Applications summary: Returns a collection of search configuration sets for an application description: A collection of search configuration sets for an application. operationId: getApplicationSearchConfigurationSets - x-cli-name: 'applications:search:configuration-set-list' + x-cli-name: applications:search:configuration-set-list security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ConfigurationSets' + $ref: "#/components/schemas/ConfigurationSets" example: total: 3 pagination: @@ -10027,20 +10912,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search limit: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?limit}' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?offset}' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?offset} templated: true sort: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?sort}' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?filter}' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets{?filter} templated: true _embedded: items: @@ -10052,66 +10937,66 @@ paths: status: active _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets download: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download - id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905 label: example-1 flags: custom: true - status: in-progress + status: pending _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets download: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download - id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn79 application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905 label: example-2 flags: custom: true - status: in-progress + status: pending _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn79' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn79 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets download: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download' - '403': + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to view search configuration sets for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. post: tags: - Applications summary: Creates a search configuration set for an application. description: Creates a search configuration set for an application. operationId: postApplicationSearchConfigurationSets - x-cli-name: 'applications:search:configuration-set-create' + x-cli-name: applications:search:configuration-set-create security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" requestBody: required: true content: @@ -10127,27 +11012,27 @@ paths: type: string description: A binary file response responses: - '202': + "202": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The search configuration set is being created. _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ notification: - href: 'https://cloud.acquia.com/api/notifications/05fb83f1-59dd-4079-b9f3-ce9243a126ed' - '400': + href: https://cloud.acquia.com/api/notifications/05fb83f1-59dd-4079-b9f3-ce9243a126ed + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Request missing uploaded file: value: @@ -10169,53 +11054,53 @@ paths: error: validation_failed message: general: The uploaded file size exceeds the 10MB limit. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to create search configuration sets on this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: conflict message: Acquia Search is not available for this subscription. - '/applications/{applicationUuid}/search/config-sets/{configurationSetId}': + "/applications/{applicationUuid}/search/config-sets/{configurationSetId}": get: tags: - Applications summary: Returns a search configuration set for an application description: A specific search configuration set. operationId: getApplicationSearchConfigurationSet - x-cli-name: 'applications:search:configuration-set-find' + x-cli-name: applications:search:configuration-set-find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/ConfigurationSetId' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/ConfigurationSetId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ConfigurationSet' + $ref: "#/components/schemas/ConfigurationSet" example: id: shared-1234567891011-121 application_uuid: 3f6d06a9-9236-411e-9dcc-44f0003a5905 @@ -10229,145 +11114,145 @@ paths: status: active _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets download: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download' - '403': + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/download + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to view search configuration sets for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or not enough permissions: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. No configuration set or not enough permissions: value: error: not_found - message: 'The search configuration set you are trying to access does not exist, or you do not have permission to access it.' + message: The search configuration set you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Applications summary: Removes and deletes a specific search configuration set from an application. description: Removes and deletes a specific search configuration set from an application. operationId: deleteApplicationSearchConfigurationSet - x-cli-name: 'applications:search:configuration-set-delete' + x-cli-name: applications:search:configuration-set-delete security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/ConfigurationSetId' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/ConfigurationSetId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The search configuration set has been deleted. _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ notification: - href: 'https://cloud.acquia.com/api/notifications/41aaeac7-7ead-4f39-b74c-42493e4dc27b' - '403': + href: https://cloud.acquia.com/api/notifications/41aaeac7-7ead-4f39-b74c-42493e4dc27b + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to delete search configuration sets for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or not enough permissions: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. No configuration set or not enough permissions: value: error: not_found - message: 'The search configuration set you are trying to access does not exist, or you do not have permission to access it.' + message: The search configuration set you are trying to access does not exist, or you do not have permission to access it. Search configuration set not available: value: error: not_found message: The configuration set is not available for this application. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: conflict message: Acquia Search is not available for this subscription. - '/applications/{applicationUuid}/settings': + "/applications/{applicationUuid}/settings": get: tags: - Applications summary: Returns available settings for this application. description: Does not return any data. Allows traversal to settings groups endpoints. operationId: getApplicationSettings - x-cli-name: 'applications:settings-list' + x-cli-name: applications:settings-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Settings' + $ref: "#/components/schemas/Settings" example: _links: self: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings hosting: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/hosting' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/hosting keys: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/keys' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/keys ra: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/ra' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/ra security: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/security' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/security parent: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470' - '404': + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/settings/hosting': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/settings/hosting": get: tags: - Applications @@ -10375,50 +11260,50 @@ paths: description: Returns the hosting settings for this application. deprecated: true operationId: getApplicationHostingSettings - x-cli-name: 'applications:hosting-settings-list' + x-cli-name: applications:hosting-settings-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/HostingSettings' + $ref: "#/components/schemas/HostingSettings" example: uuid: abcd1234-1111-2222-3333-0e02b2c3d470 - hosting_id: 'master:site' + hosting_id: master:site type: ace _links: self: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/hosting' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/hosting parent: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings' - '403': + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: not_found message: You do not have permission to access the hosting settings. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/settings/keys': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/settings/keys": get: tags: - Applications @@ -10426,18 +11311,18 @@ paths: description: Returns the legacy product keys for this application. deprecated: true operationId: getApplicationLegacyProductKeysSettings - x-cli-name: 'applications:legacy-product-key-find' + x-cli-name: applications:legacy-product-key-find parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/LegacyProductKeysSettings' + $ref: "#/components/schemas/LegacyProductKeysSettings" example: acquia_connector: identifier: ABCD-12345 @@ -10447,56 +11332,56 @@ paths: key: 123456787987a135e2c143601328cbf1 _links: self: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/keys' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/keys parent: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings' - '403': + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/settings + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to access these product keys. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/settings/ra': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/settings/ra": get: tags: - Applications summary: Returns the remote administration settings for this application. description: Returns the remote administration settings for this application. operationId: getApplicationRemoteAdministrationSettings - x-cli-name: 'applications:ra-settings-find' + x-cli-name: applications:ra-settings-find parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/RemoteAdministrationSettings' + $ref: "#/components/schemas/RemoteAdministrationSettings" example: application_uuid: abcd1234-1111-2222-3333-0e02b2c3d470 update_mode: full update_type: core - pause_until: '2016-03-04T12:01:05-0500' - deploy_at: '2016-03-04T12:01:05-0500' + pause_until: 2016-03-04T12:01:05-0500 + deploy_at: 2016-03-04T12:01:05-0500 deploy_environment: test source_environment: prod merge_branch: master @@ -10506,15 +11391,15 @@ paths: merge_tag: false _links: self: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/ra' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/ra parent: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings' - '403': + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -10524,32 +11409,32 @@ paths: value: error: forbidden message: This application does not have remote administration. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. put: tags: - Applications summary: Modifies the remote administration settings for an application. description: Modifies the remote administration settings for an application. operationId: putApplicationRemoteAdministrationSettings - x-cli-name: 'applications:ra-settings-update' + x-cli-name: applications:ra-settings-update parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/RemoteAdministration' + $ref: "#/components/schemas/RemoteAdministration" example: update_mode: update update_type: core_contrib @@ -10563,26 +11448,26 @@ paths: merge_branch: master application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/RemoteAdministration' + $ref: "#/components/schemas/RemoteAdministration" example: - $ref: '#/paths/~1applications~1%7BapplicationUuid%7D~1settings~1ra/put/requestBody/content/application~1json/example' + $ref: "#/paths/~1applications~1%7BapplicationUuid%7D~1settings~1ra/put/requestBody/content/application~1hal%2Bjson/example" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: The remote administration settings have been updated - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: No parameters: value: @@ -10598,7 +11483,7 @@ paths: value: error: validation_failed message: - update_mode: 'The remote administration mode ''something'' is invalid. Must be one of ''update'', ''inform'', or ''none''.' + update_mode: The remote administration mode 'something' is invalid. Must be one of 'update', 'inform', or 'none'. Invalid remote administration update type: value: error: validation_failed @@ -10629,12 +11514,12 @@ paths: error: validation_failed message: deploy_environment: The source environment is not valid. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Unsufficient permissions: value: @@ -10648,18 +11533,18 @@ paths: value: error: forbidden message: Remote admin is not available on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found or does not exist: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/settings/security': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/settings/security": get: tags: - Applications @@ -10667,18 +11552,18 @@ paths: description: Returns the security policy settings for this application. deprecated: true operationId: getApplicationSecuritySettings - x-cli-name: 'applications:security-settings-find' + x-cli-name: applications:security-settings-find parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SecuritySettings' + $ref: "#/components/schemas/SecuritySettings" example: application_uuid: abcd1234-1111-2222-3333-0e02b2c3d470 allowed_ips: @@ -10687,20 +11572,20 @@ paths: tfa_required: true _links: self: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/security' + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings/security parent: - href: 'https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings' - '404': + href: https://cloud.acquia.com/api/applications/abcd1234-1111-2222-3333-0e02b2c3d470/settings + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. put: tags: - Applications @@ -10708,13 +11593,13 @@ paths: description: Modifies the security policy settings for an application. deprecated: true operationId: putApplicationSecuritySettings - x-cli-name: 'applications:security-settings-update' + x-cli-name: applications:security-settings-update parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -10757,20 +11642,20 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: The security policy settings have been updated. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: No parameters: value: @@ -10781,62 +11666,62 @@ paths: value: error: validation_failed message: - allowed_ips: 'The list of allowed IPs is invalid. Must either be an array of IPs to whitelist, or null to disable IP whitelisting.' + allowed_ips: The list of allowed IPs is invalid. Must either be an array of IPs to whitelist, or null to disable IP whitelisting. Invalid IP address in list: value: error: validation_failed message: allowed_ips: The IP address \"not-a-valid-ip-address\" is invalid. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to edit the security policy settings for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found or does not exist: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Action unavailable: value: error: conflict message: The security policy is already configured to these settings. - '/applications/{applicationUuid}/tags': + "/applications/{applicationUuid}/tags": get: tags: - Applications summary: Returns a list of application tags associated with this application. description: Returns a list of application tags associated with this application. operationId: getApplicationTags - x-cli-name: 'applications:tag-list' + x-cli-name: applications:tag-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ResourceTags' + $ref: "#/components/schemas/ResourceTags" example: total: 1 pagination: @@ -10845,20 +11730,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags parent: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a limit: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?limit}' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?offset}' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?offset} templated: true sort: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?sort}' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?filter}' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags{?filter} templated: true _embedded: items: @@ -10873,33 +11758,33 @@ paths: - 185f07c7-9c4f-407b-8968-67892ebcb38a _links: self: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags/Dev' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags/Dev parent: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags' - '404': + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tags + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. post: tags: - Applications summary: Creates a new application tag. description: Creates a new application tag. operationId: postApplicationsTags - x-cli-name: 'applications:tags-create' + x-cli-name: applications:tags-create parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object description: Application tags. @@ -10940,73 +11825,73 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The tag has been added to the application. _links: self: - href: 'https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags' + href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags parent: - href: 'https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb' + href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb notification: - href: 'https://cloud.acquia.com/api/notifications/773fca86-9d87-45dc-9220-9ba38306bbb1' - '404': + href: https://cloud.acquia.com/api/notifications/773fca86-9d87-45dc-9220-9ba38306bbb1 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No user: value: error: not_found - message: 'The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/tags/{tagName}': + message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/tags/{tagName}": delete: tags: - Applications summary: Deletes an application tag. description: Deletes an application tag. operationId: deleteApplicationTags - x-cli-name: 'applications:tags-delete' + x-cli-name: applications:tags-delete parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/TagName' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/TagName" security: - OAuth2: [] responses: - '200': + "200": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The tag has been removed from the application. _links: self: - href: 'https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags/test_tag' + href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags/test_tag parent: - href: 'https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags' + href: https://cloud.acquia.com/api/applications/0d9fc48f-9871-41d9-8b41-0f815e6039eb/tags notification: - href: 'https://cloud.acquia.com/api/notifications/37cdf705-9774-4526-9bf0-9feb279630ee' - '404': + href: https://cloud.acquia.com/api/notifications/37cdf705-9774-4526-9bf0-9feb279630ee + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No user: value: error: not_found - message: 'The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/tasks': + message: The Application with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/tasks": get: tags: - Applications @@ -11029,36 +11914,36 @@ paths: * `started` deprecated: true operationId: getApplicationTasks - x-cli-name: 'applications:task-list' + x-cli-name: applications:task-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationsTasks' + $ref: "#/components/schemas/ApplicationsTasks" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks sort: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?sort}' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?filter}' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?limit}' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/tasks{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a _embedded: items: - progress: 100 @@ -11066,19 +11951,19 @@ paths: uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a first_name: Example last_name: User - last_login_at: '2019-05-23T16:12:12-04:00' - created_at: '2015-08-14T17:37:21-04:00' + last_login_at: 2019-05-23T16:12:12-04:00 + created_at: 2015-08-14T17:37:21-04:00 mail: example.user@example.com - picture_url: 'https://accounts.acquia.com/images/users/d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a/style/avatar' + picture_url: https://accounts.acquia.com/images/users/d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a/style/avatar username: example.user id: 8c6dde1f-fd0c-45e3-b6a3-f335397a1a76 uuid: 8c6dde1f-fd0c-45e3-b6a3-f335397a1a76 name: ApplicationAddedToTeam title: Application added to team. description: Application Example Application has been added to team Example Team - created_at: '2019-04-16T13:24:55-04:00' - started_at: '2019-04-16T13:24:55-04:00' - completed_at: '2019-04-16T13:24:55-04:00' + created_at: 2019-04-16T13:24:55-04:00 + started_at: 2019-04-16T13:24:55-04:00 + completed_at: 2019-04-16T13:24:55-04:00 status: completed type: task metadata: @@ -11106,25 +11991,25 @@ paths: reference_uuid: d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a _links: self: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/notifications/8c6dde1f-fd0c-45e3-b6a3-f335397a1a76' + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/notifications/8c6dde1f-fd0c-45e3-b6a3-f335397a1a76 - progress: 0 user: uuid: 66597696-118c-4e18-b7e8-d027df8d5faa first_name: Example last_name: User - last_login_at: '2019-05-30T18:08:36-04:00' - created_at: '2015-08-13T19:37:00-04:00' + last_login_at: 2019-05-30T18:08:36-04:00 + created_at: 2015-08-13T19:37:00-04:00 mail: example.user.2@example.com - picture_url: 'https://accounts.acquia.com/images/users/66597696-118c-4e18-b7e8-d027df8d5faa/style/avatar' + picture_url: https://accounts.acquia.com/images/users/66597696-118c-4e18-b7e8-d027df8d5faa/style/avatar username: example.user.2 id: a0b253b7-df89-4b45-950b-f1d1e8873d30 uuid: a0b253b7-df89-4b45-950b-f1d1e8873d30 name: FilesCopied title: Files copied description: Files copied from "prod" to "dev". - created_at: '2019-01-25T04:24:32-05:00' - started_at: '2019-01-25T04:24:32-05:00' - completed_at: '2019-01-25T04:24:46-05:00' + created_at: 2019-01-25T04:24:32-05:00 + started_at: 2019-01-25T04:24:32-05:00 + completed_at: 2019-01-25T04:24:46-05:00 status: completed type: task metadata: @@ -11137,7 +12022,7 @@ paths: - 927-185f07c7-9c4f-407b-8968-67892ebcb38a hosting: task: - id: '12345678' + id: "12345678" master: example author: uuid: 66597696-118c-4e18-b7e8-d027df8d5faa @@ -11159,19 +12044,19 @@ paths: reference_uuid: a0b253b7-df89-4b45-950b-f1d1e8873d30 _links: self: - href: 'https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/notifications/a0b253b7-df89-4b45-950b-f1d1e8873d30' - '404': + href: https://cloud.acquia.com/api/applications/185f07c7-9c4f-407b-8968-67892ebcb38a/notifications/a0b253b7-df89-4b45-950b-f1d1e8873d30 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/teams': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/teams": get: tags: - Applications @@ -11185,29 +12070,29 @@ paths: Sortable fields: * `name` operationId: getApplicationTeams - x-cli-name: 'applications:team-list' + x-cli-name: applications:team-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationsTeams' + $ref: "#/components/schemas/ApplicationsTeams" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/applications/abcded12-1234-11e1-9eb5-12313928d5b8/teams' + href: https://cloud.acquia.com/api/applications/abcded12-1234-11e1-9eb5-12313928d5b8/teams parent: - href: 'https://cloud.acquia.com/api/applications/abcded12-1234-11e1-9eb5-12313928d5b8' + href: https://cloud.acquia.com/api/applications/abcded12-1234-11e1-9eb5-12313928d5b8 _embedded: items: - uuid: abcd1234-82b5-11e3-9170-12313920a02c @@ -11219,7 +12104,7 @@ paths: name: Sample Organization _links: self: - href: 'https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c' + href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c - uuid: 1234abcd-82b5-11e3-9170-12313920a02c name: Team Name 2 created_at: '2014-05-27T11:55:39-0700' @@ -11229,121 +12114,121 @@ paths: name: Sample Organization _links: self: - href: 'https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f' - '404': + href: https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/metrics/usage': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/metrics/usage": get: tags: - Applications summary: Retrieves traversal links for detailed metrics on usage (views and visits) of your application. description: Retrieves traversal links for an application's usage data. operationId: getApplicationsUsageLinks - x-cli-name: 'applications:usage-links' + x-cli-name: applications:usage-links parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Usage' + $ref: "#/components/schemas/Usage" example: _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics data: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data data-by-environment: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment views: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views views-by-environment: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment visits: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits visits-by-environment: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment' - '403': + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/metrics/usage/data': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/metrics/usage/data": get: tags: - Applications - summary: 'Retrieves aggregate usage data for an application, filterable by views or visits and by environment.' + summary: Retrieves aggregate usage data for an application, filterable by views or visits and by environment. description: | Filterable fields: * `metric` - One of: {`views`, `visits`} * `environment` operationId: getApplicationsUsageData - x-cli-name: 'applications:usage-data' + x-cli-name: applications:usage-data parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationUsageMetrics' + $ref: "#/components/schemas/ApplicationUsageMetrics" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage filter: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data{?filter}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data{?filter} templated: true _embedded: items: - metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -11359,15 +12244,15 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: visits datapoints: - - '2019-03-13T00:00:00+00:00' - - '3' + - "3" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -11383,57 +12268,57 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/metrics/usage/data-by-environment': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/metrics/usage/data-by-environment": get: tags: - Applications - summary: 'Retrieves usage data (views or visits) for an application, broken down by environment.' + summary: Retrieves usage data (views or visits) for an application, broken down by environment. description: | Filterable fields: * `metric` - One of: {`views`, `visits`} * `environment` operationId: getApplicationsUsageDataByEnvironment - x-cli-name: 'applications:usage-data-by-environment' + x-cli-name: applications:usage-data-by-environment parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationUsageMetric' + $ref: "#/components/schemas/ApplicationUsageMetrics" example: total: 6 pagination: @@ -11442,17 +12327,17 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage limit: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?limit}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?offset}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?offset} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?filter}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data-by-environment{?filter} templated: true _embedded: items: @@ -11471,9 +12356,9 @@ paths: - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: visits datapoints: [] last_data_at: null @@ -11489,15 +12374,15 @@ paths: - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -11511,15 +12396,15 @@ paths: - 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: visits datapoints: - - '2019-03-13T00:00:00+00:00' - - '3' + - "3" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -11533,9 +12418,9 @@ paths: - 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: views datapoints: [] last_data_at: null @@ -11551,9 +12436,9 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: visits datapoints: [] last_data_at: null @@ -11569,32 +12454,32 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/metrics/usage/{usageMetric}': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/metrics/usage/{usageMetric}": get: tags: - Applications @@ -11603,28 +12488,28 @@ paths: Filterable fields: * `environment` operationId: getApplicationsUsageMetricData - x-cli-name: 'applications:usage-metric-data' + x-cli-name: applications:usage-metric-data parameters: - - $ref: '#/components/parameters/UsageMetric' - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' + - $ref: "#/components/parameters/UsageMetric" + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationUsageMetric' + $ref: "#/components/schemas/ApplicationUsageMetric" example: metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -11640,56 +12525,56 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/metrics/usage/views-by-environment': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/metrics/usage/views-by-environment": get: tags: - Applications - summary: 'Retrieves views data for an application, broken down by environment.' + summary: Retrieves views data for an application, broken down by environment. description: | Filterable fields: * `environment` operationId: getApplicationsUsageViewsDataByEnvironment - x-cli-name: 'applications:usage-views-data-by-environment' + x-cli-name: applications:usage-views-data-by-environment parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationUsageMetric' + $ref: "#/components/schemas/ApplicationUsageMetrics" example: total: 3 pagination: @@ -11698,17 +12583,17 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage limit: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?limit}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?offset}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?offset} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?filter}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views-by-environment{?filter} templated: true _embedded: items: @@ -11727,15 +12612,15 @@ paths: - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -11749,9 +12634,9 @@ paths: - 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: views datapoints: [] last_data_at: null @@ -11767,56 +12652,56 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/metrics/usage/visits-by-environment': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/metrics/usage/visits-by-environment": get: tags: - Applications - summary: 'Retrieves visits data for an application, broken down by environment.' + summary: Retrieves visits data for an application, broken down by environment. description: | Filterable fields: * `environment` operationId: getApplicationsUsageVisitsDataByEnvironment - x-cli-name: 'applications:usage-visits-data-by-environment' + x-cli-name: applications:usage-visits-data-by-environment parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationUsageMetric' + $ref: "#/components/schemas/ApplicationUsageMetrics" example: total: 3 pagination: @@ -11825,17 +12710,17 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage limit: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?limit}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?offset}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?offset} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?filter}' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits-by-environment{?filter} templated: true _embedded: items: @@ -11854,15 +12739,15 @@ paths: - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: visits datapoints: - - '2019-03-13T00:00:00+00:00' - - '3' + - "3" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -11876,9 +12761,9 @@ paths: - 124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/124-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: visits datapoints: [] last_data_at: null @@ -11894,191 +12779,191 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/environments/125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. /distributions: get: tags: - Distributions summary: Return a list of Drupal distributions. operationId: getDistributions - x-cli-name: 'distributions:list' + x-cli-name: distributions:list security: - OAuth2: [] description: | Returns a list of Drupal distributions that are available for installation in an Acquia Cloud environment. responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Distributions' + $ref: "#/components/schemas/Distributions" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/distributions' + href: https://cloud.acquia.com/api/distributions parent: - href: 'https://cloud.acquia.com/api/' + href: https://cloud.acquia.com/api/ _embedded: items: - name: drupal7 urls: - gz: 'http://www.acquia.com/path/to/archive/drupal7.tar.gz' - zip: 'http://www.acquia.com/path/to/archive/drupal7.zip' + gz: http://www.acquia.com/path/to/archive/drupal7.tar.gz + zip: http://www.acquia.com/path/to/archive/drupal7.zip update_urls: - gz: 'http://www.acquia.com/path/to/archive/drupal7-update.tar.gz' - zip: 'http://www.acquia.com/path/to/archive/drupal7-update.zip' + gz: http://www.acquia.com/path/to/archive/drupal7-update.tar.gz + zip: http://www.acquia.com/path/to/archive/drupal7-update.zip title: Acquia Drupal version: 7.38.44-6261 drupal_version: Drupal 7 description: Acquia Drupal makes building your Drupal website easier by including both the current Drupal core along with a collection of essential modules. - image_url: 'https://www.acquia.com/path/to/img/drupal7.png' + image_url: https://www.acquia.com/path/to/img/drupal7.png flags: default: true $visible: true _links: self: - href: 'https://cloud.acquia.com/api/distributions/drupal7' + href: https://cloud.acquia.com/api/distributions/drupal7 - name: drupal8 urls: - gz: 'http://www.acquia.com/path/to/archive/drupal8.tar.gz' - zip: 'http://www.acquia.com/path/to/archive/drupal8.zip' + gz: http://www.acquia.com/path/to/archive/drupal8.tar.gz + zip: http://www.acquia.com/path/to/archive/drupal8.zip update_urls: - gz: 'http://www.acquia.com/path/to/archive/drupal8-update.tar.gz' - zip: 'http://www.acquia.com/path/to/archive/drupal8-update.zip' + gz: http://www.acquia.com/path/to/archive/drupal8-update.tar.gz + zip: http://www.acquia.com/path/to/archive/drupal8-update.zip title: Acquia Drupal version: 8.0.0-beta14 drupal_version: Drupal 8 description: Acquia Drupal makes building your Drupal website easier by including both the current Drupal core along with a collection of essential modules. - image_url: 'https://www.acquia.com/path/to/img/drupal8.png' + image_url: https://www.acquia.com/path/to/img/drupal8.png flags: default: false $visible: false _links: self: - href: 'https://cloud.acquia.com/api/distributions/drupal8' - '/distributions/{name}': + href: https://cloud.acquia.com/api/distributions/drupal8 + "/distributions/{name}": get: tags: - Distributions summary: Return details about a specific Drupal distribution. operationId: getDistributionByName - x-cli-name: 'distributions:find' + x-cli-name: distributions:find security: - OAuth2: [] description: | A specific distribution. parameters: - - $ref: '#/components/parameters/Name' + - $ref: "#/components/parameters/Name" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Distribution' + $ref: "#/components/schemas/Distribution" example: name: drupal8 urls: - gz: 'http://www.acquia.com/path/to/archive/drupal8.tar.gz' - zip: 'http://www.acquia.com/path/to/archive/drupal8.zip' + gz: http://www.acquia.com/path/to/archive/drupal8.tar.gz + zip: http://www.acquia.com/path/to/archive/drupal8.zip update_urls: - gz: 'http://www.acquia.com/path/to/archive/drupal8-update.tar.gz' - zip: 'http://www.acquia.com/path/to/archive/drupal8-update.zip' + gz: http://www.acquia.com/path/to/archive/drupal8-update.tar.gz + zip: http://www.acquia.com/path/to/archive/drupal8-update.zip title: Acquia Drupal version: 8.0.0-beta14 drupal_version: Drupal 8 description: Acquia Drupal makes building your Drupal website easier by including both the current Drupal core along with a collection of essential modules. - image_url: 'https://www.acquia.com/path/to/img/drupal8.png' + image_url: https://www.acquia.com/path/to/img/drupal8.png flags: default: false $visible: true _links: self: - href: 'https://cloud.acquia.com/api/distributions/drupal8' + href: https://cloud.acquia.com/api/distributions/drupal8 gz: - href: 'http://www.acquia.com/path/to/archive/drupal8.tar.gz' + href: http://www.acquia.com/path/to/archive/drupal8.tar.gz zip: - href: 'http://www.acquia.com/path/to/archive/drupal8.zip' + href: http://www.acquia.com/path/to/archive/drupal8.zip update_gz: - href: 'http://www.acquia.com/path/to/archive/drupal8-update.tar.gz' + href: http://www.acquia.com/path/to/archive/drupal8-update.tar.gz update_zip: - href: 'http://www.acquia.com/path/to/archive/drupal8-update.zip' + href: http://www.acquia.com/path/to/archive/drupal8-update.zip parent: - href: 'https://cloud.acquia.com/api/distributions' - '404': + href: https://cloud.acquia.com/api/distributions + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found message: The distribution you are trying to access does not exist. - '/applications/{applicationUuid}/environments': + "/applications/{applicationUuid}/environments": get: tags: - Applications summary: Returns a list of environments within this application by its UUID. description: Returns a list of environments within this application. operationId: getApplicationEnvironments - x-cli-name: 'applications:environment-list' + x-cli-name: applications:environment-list parameters: - - $ref: '#/components/parameters/ApplicationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/ApplicationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Environments' + $ref: "#/components/schemas/Environments" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments sort: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?sort}' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?filter}' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?limit}' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/environments{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 _embedded: items: - id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470 @@ -12101,12 +12986,12 @@ paths: platform: cloud status: normal type: drupal - size: null + size: medium weight: 0 vcs: type: git path: master - url: 'site@svn-3.hosted.acquia-sites.com:site.git' + url: site@svn-3.hosted.acquia-sites.com:site.git flags: cde: false cdn: false @@ -12124,7 +13009,7 @@ paths: configuration: operating_system: precise php: - version: '8.0' + version: "8.1" memory_limit: 128 opcache: 96 apcu: 32 @@ -12136,7 +13021,7 @@ paths: artifact: null _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470 - id: 15-a47ac10b-58cc-4372-a567-0e02b2c3d470 label: Production name: prod @@ -12161,12 +13046,12 @@ paths: platform: cloud status: normal type: drupal - size: null + size: medium weight: 0 vcs: type: git path: tags/01-01-2015 - url: 'site@svn-3.hosted.acquia-sites.com:site.git' + url: site@svn-3.hosted.acquia-sites.com:site.git flags: cde: false cdn: false @@ -12185,7 +13070,7 @@ paths: artifact: null _links: self: - href: 'https://cloud.acquia.com/api/environments/15-a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/15-a47ac10b-58cc-4372-a567-0e02b2c3d470 - id: 32-a47ac10b-58cc-4372-a567-0e02b2c3d470 label: Stage name: test @@ -12210,7 +13095,7 @@ paths: vcs: type: git path: null - url: 'qa10@svn-3.networkdev.ahserversdev.com:qa10.git' + url: qa10@svn-3.networkdev.ahserversdev.com:qa10.git flags: cde: false cdn: false @@ -12234,13 +13119,13 @@ paths: name: Example artifact _links: self: - href: 'https://cloud.acquia.com/api/environments/32-a47ac10b-58cc-4372-a567-0e02b2c3d470' - '404': + href: https://cloud.acquia.com/api/environments/32-a47ac10b-58cc-4372-a567-0e02b2c3d470 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: @@ -12252,13 +13137,13 @@ paths: summary: Add a new continuous delivery environment to an application by the application UUID. description: Add a new continuous delivery environment. operationId: postApplicationEnvironments - x-cli-name: 'applications:environment-create' + x-cli-name: applications:environment-create parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -12307,35 +13192,35 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Adding environment: value: message: Adding an environment. _links: self: - href: 'https://cloud.acquia.com/api/applications/896f142a-2c14-45ff-9b1f-41bcb2b5de8d/environments' + href: https://cloud.acquia.com/api/applications/896f142a-2c14-45ff-9b1f-41bcb2b5de8d/environments notification: - href: 'https://cloud.acquia.com/api/notifications/23d9184d-40b8-4f21-a3d5-416aef9bcd39' + href: https://cloud.acquia.com/api/notifications/23d9184d-40b8-4f21-a3d5-416aef9bcd39 parent: - href: 'https://cloud.acquia.com/api/applications/896f142a-2c14-45ff-9b1f-41bcb2b5de8d/environments' - '400': + href: https://cloud.acquia.com/api/applications/896f142a-2c14-45ff-9b1f-41bcb2b5de8d/environments + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Application is not hosted by Acquia: value: error: validation_failed @@ -12371,12 +13256,12 @@ paths: error: validation_failed message: general: You cannot provision more than 3 databases on your new environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -12390,44 +13275,44 @@ paths: value: error: forbidden message: CD environments cannot be added to non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/applications/{applicationUuid}/features': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/applications/{applicationUuid}/features": get: tags: - Applications summary: Return application features. operationId: getApplicationFeatures - x-cli-name: 'applications:feature-list' + x-cli-name: applications:feature-list security: - OAuth2: [] description: | Returns a list of feature flags for this application. parameters: - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/ApplicationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApplicationFeatures' + $ref: "#/components/schemas/ApplicationFeatures" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/features' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/features parent: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 _embedded: items: - name: feature-name @@ -12436,7 +13321,7 @@ paths: - name: example-feature label: Example feature. description: Allows access to Example feature. - '/environments/{environmentId}': + "/environments/{environmentId}": get: tags: - Environments @@ -12457,18 +13342,18 @@ paths: 4. See the environment ID in the browser URL. For example, in this URL `https://cloud.acquia.com/app/develop/applications/53785bca-1946-4adc-a022-e50d24686c20/environments/289576-53785bca-1946-4adc-a022-e50d24686c20`, the environment id is `289576-53785bca-1946-4adc-a022-e50d24686c20`. operationId: getEnvironment - x-cli-name: 'environments:find' + x-cli-name: environments:find parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Environment' + $ref: "#/components/schemas/Environment" example: id: 24-a47ac10b-58cc-4372-a567-0e02b2c3d470 label: Dev @@ -12490,12 +13375,12 @@ paths: platform: cloud status: normal type: drupal - size: null + size: medium weight: 0 vcs: type: git path: master - url: 'site@svn-3.hosted.acquia-sites.com:site.git' + url: site@svn-3.hosted.acquia-sites.com:site.git flags: cde: false cdn: false @@ -12515,7 +13400,7 @@ paths: configuration: operating_system: precise php: - version: '8.0' + version: "8.1" memory_limit: 128 opcache: 96 apcu: 64 @@ -12530,117 +13415,117 @@ paths: artifact: null _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470 parent: - href: 'https://cloud.acquia.com/api/environments' + href: https://cloud.acquia.com/api/environments available-runtimes: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/available-runtimes' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/available-runtimes cdn: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cdn' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cdn cloud-actions: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cloud-actions' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cloud-actions crons: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons databases: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases dns: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/dns' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/dns domains: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains eips: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips logs: - href: 'https://cloud.acquia.com/api/environments/8-185f07c7-9c4f-407b-8968-67892ebcb38a/logs' + href: https://cloud.acquia.com/api/environments/8-185f07c7-9c4f-407b-8968-67892ebcb38a/logs metrics: - href: 'https://cloud.acquia.com/api/environments/8-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics' + href: https://cloud.acquia.com/api/environments/8-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics search: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/search' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/search servers: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers ssl: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/ssl' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/ssl variables: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/variables' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/variables _embedded: application: name: Sample application uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470 _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' - '404': + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. put: tags: - Environments summary: Modifies configuration settings for an environment. description: Modifies configuration settings for an environment. Note that some settings cannot be configured for certain subscriptions. operationId: putEnvironment - x-cli-name: 'environments:update' + x-cli-name: environments:update parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/EnvironmentConfigurations' + $ref: "#/components/schemas/EnvironmentConfigurations" example: - version: '8.0' + version: "8.1" max_execution_time: 10 memory_limit: 192 - apcu: 8 + apcu: 32 max_input_vars: 1000 max_post_size: 256 memcached_limit: 128 application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/EnvironmentConfigurations' + $ref: "#/components/schemas/EnvironmentConfigurations" example: - $ref: '#/paths/~1environments~1%7BenvironmentId%7D/put/requestBody/content/application~1json/example' + $ref: "#/paths/~1environments~1%7BenvironmentId%7D/put/requestBody/content/application~1hal%2Bjson/example" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The environment configuration is being updated. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93 notification: - href: 'https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5' - '400': + href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: No changes requested: value: error: forbidden message: system: No environment configuration changes are specified. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -12654,48 +13539,48 @@ paths: value: error: forbidden message: Environments cannot be deleted on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Environments summary: Deletes a CD environment. description: Deletes a CD environment. operationId: deleteEnvironment - x-cli-name: 'environments:delete' + x-cli-name: environments:delete parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: The environment is being deleted. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1' + href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1 notification: - href: 'https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69' - '403': + href: https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -12713,35 +13598,35 @@ paths: value: error: forbidden message: Environments cannot be deleted on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. Environment Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/actions/clear-caches': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/actions/clear-caches": post: tags: - Environments summary: Clears the caches for one or more domains attached to this environment. description: Clear caches for Varnish and Platform CDN (if Platform CDN is enabled). operationId: postEnvironmentsClearCaches - x-cli-name: 'environments:clear-caches' + x-cli-name: environments:clear-caches parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: required: - domains @@ -12751,7 +13636,7 @@ paths: description: A list of domains to clear the caches for. items: type: string - format: uri + format: hostname example: domains: - domain1.example.com @@ -12759,27 +13644,27 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Clearing cache: value: message: Caches are being cleared. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/actions/clear-caches' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/actions/clear-caches notification: - href: 'https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c' - '403': + href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -12793,18 +13678,18 @@ paths: value: error: forbidden message: Caches cannot be cleared on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/actions/change-label': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/actions/change-label": post: tags: - Environments @@ -12812,15 +13697,15 @@ paths: deprecated: true description: Change the label for an environment. operationId: postChangeEnvironmentLabel - x-cli-name: 'environments:label-update' + x-cli-name: environments:label-update security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -12843,39 +13728,39 @@ paths: example: label: New Label responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Changing label: value: message: Changing environment label. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Label already used: value: error: validation_failed message: label: Another environment within this application already has this label. - '403': + "403": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -12885,18 +13770,18 @@ paths: value: error: forbidden message: Environment labels cannot be changed on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/actions/migrate': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/actions/migrate": post: tags: - Environments @@ -12905,15 +13790,15 @@ paths: deprecated: false description: Create a Migrate Environment using the provided environment as its source. operationId: postMigrateEnvironment - x-cli-name: 'environments:migrate' + x-cli-name: environments:migrate security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -12944,35 +13829,35 @@ paths: label: Migrate Environment config: true responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Creating Migrate Environment: value: message: The Migrate Environment is being created. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9/actions/migrate' + href: https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9/actions/migrate parent: - href: 'https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9' + href: https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9 notification: - href: 'https://cloud.acquia.com/api/notifications/d4315515-9c1a-4153-9e88-0b681d5c76b2' - '400': + href: https://cloud.acquia.com/api/notifications/d4315515-9c1a-4153-9e88-0b681d5c76b2 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Not available: value: error: validation_failed @@ -12998,29 +13883,29 @@ paths: error: validation_failed message: label: Another environment within this application already has this label. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have sufficient permission to manage the Migrate Environment on this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The Migrate Environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/actions/promote': + message: The Migrate Environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/actions/promote": post: tags: - Environments @@ -13029,15 +13914,15 @@ paths: deprecated: false description: Promote a Migrate Environment. operationId: postPromoteEnvironment - x-cli-name: 'environments:promote' + x-cli-name: environments:promote security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -13060,35 +13945,35 @@ paths: example: target: 6a534a67-2d89-406d-95c8-efb515342983 responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Promoting Migrate Environment: value: message: The Migrate Environment is being promoted. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9/actions/promote' + href: https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9/actions/promote parent: - href: 'https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9' + href: https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9 notification: - href: 'https://cloud.acquia.com/api/notifications/d4315515-9c1a-4153-9e88-0b681d5c76b2' - '400': + href: https://cloud.acquia.com/api/notifications/d4315515-9c1a-4153-9e88-0b681d5c76b2 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Not available: value: error: validation_failed @@ -13109,12 +13994,12 @@ paths: error: validation_failed message: label: The environment is not a valid target for promotion. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Cannot manage Migrate Environment: value: @@ -13124,22 +14009,22 @@ paths: value: error: forbidden message: You do not have sufficient permission to promote to the target environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. Migrate Environment not found: value: error: not_found - message: 'The Migrate Environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/actions/refresh': + message: The Migrate Environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/actions/refresh": post: tags: - Environments @@ -13148,35 +14033,35 @@ paths: deprecated: false description: Refreshes a Migrate Environment. operationId: postRefreshEnvironment - x-cli-name: 'environments:refresh' + x-cli-name: environments:refresh security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Refreshing Migrate Environment: value: message: The Migrate Environment is being refreshed. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9/actions/refresh' + href: https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9/actions/refresh parent: - href: 'https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9' + href: https://cloud.acquia.com/api/environments/123-fa83c358-42bb-44d3-8e22-d046168af6d9 notification: - href: 'https://cloud.acquia.com/api/notifications/d4315515-9c1a-4153-9e88-0b681d5c76b2' - '400': + href: https://cloud.acquia.com/api/notifications/d4315515-9c1a-4153-9e88-0b681d5c76b2 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Not available: value: @@ -13193,44 +14078,44 @@ paths: error: validation_failed message: general: The environment is not a Migrate Environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have sufficient permission to refresh the Migrate Environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The Migrate Environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/artifacts/actions/switch': + message: The Migrate Environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/artifacts/actions/switch": post: tags: - Environments summary: Deploys an artifact to this environment. description: Deploys an artifact to this environment. operationId: postDeployArtifact - x-cli-name: 'environments:artifact-deploy' + x-cli-name: environments:artifact-deploy security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -13240,7 +14125,7 @@ paths: type: string description: The id of the artifact to deploy. example: - artifact_id: 123 + artifact_id: "123" application/x-www-form-urlencoded: schema: type: object @@ -13251,41 +14136,41 @@ paths: type: string description: The id of the artifact to deploy. example: - artifact_id: 123 + artifact_id: "123" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Deploying artifact: value: message: Deploying artifact. _links: self: - href: 'https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/artifacts/actions/switch' + href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/artifacts/actions/switch notification: - href: 'https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5' - '400': + href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5 + "400": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Only ready artifacts can be deployed: value: error: validation_failed message: artifact_id: Only artifacts that are in the 'ready' state can be deployed. - '403': + "403": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -13303,66 +14188,66 @@ paths: value: error: forbidden message: Artifacts can only be deployed on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: conflict message: The artifact with ID 123 does not belong to this application and cannot be deployed. - '/environments/{environmentId}/available-runtimes': + "/environments/{environmentId}/available-runtimes": get: tags: - Environments summary: Return a list of runtimes. description: Returns a list of available runtimes. operationId: getAvailableRuntimes - x-cli-name: 'environments:runtime-list' + x-cli-name: environments:runtime-list parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/AvailableRuntimes' + $ref: "#/components/schemas/AvailableRuntimes" example: runtime: php versions: - - '7.4' - - '8.0' + - "7.4" + - "8.1" _links: self: - href: 'https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/available-runtimes' + href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/available-runtimes parent: - href: 'https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93' - '404': + href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found @@ -13370,99 +14255,99 @@ paths: Not found or insufficient permissions: value: error: not_found - message: 'The available runtimes you are trying to access do not exist, or you do not have permission to access them.' - '/environments/{environmentId}/cdn': + message: The available runtimes you are trying to access do not exist, or you do not have permission to access them. + "/environments/{environmentId}/cdn": get: tags: - Environments summary: Returns the CDN status for an environment. description: Returns the CDN status for an environment. The CDN must be enabled for the status to be displayed. operationId: getCdnByEnvironmentId - x-cli-name: 'environments:cdn-find' + x-cli-name: environments:cdn-find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Cdn' + $ref: "#/components/schemas/Cdn" example: status: active _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cdn' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/cdn parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470' - '404': + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: CDN not found: value: error: not_found - message: 'The CDN you are trying to access does not exist, or you do not have permission to access it.' + message: The CDN you are trying to access does not exist, or you do not have permission to access it. post: tags: - Environments summary: Enables a CDN for an environment. description: Enables a CDN for an environment. operationId: postCdnByEnvironmentId - x-cli-name: 'environments:cdn-enable' + x-cli-name: environments:cdn-enable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Provisioning Platform CDN. _links: self: - href: 'https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4/cdn' + href: https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4/cdn parent: - href: 'https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4' + href: https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4 notification: - href: 'https://cloud.acquia.com/api/notifications/ea01b886-40bb-c028-b3de-4353e25fa462' - '403': + href: https://cloud.acquia.com/api/notifications/ea01b886-40bb-c028-b3de-4353e25fa462 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have sufficient permission to enable CDN for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not supported: value: @@ -13478,55 +14363,55 @@ paths: summary: Disables a CDN for an environment. description: Disables a CDN for an environment. operationId: deleteCdnByEnvironmentId - x-cli-name: 'environments:cdn-disable' + x-cli-name: environments:cdn-disable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Deprovisioning Platform CDN. _links: self: - href: 'https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4/cdn' + href: https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4/cdn parent: - href: 'https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4' + href: https://cloud.acquia.com/api/environments/8237-8675-93b8-4f45-cf515fec-e016647b53d4 notification: - href: 'https://cloud.acquia.com/api/notifications/ea01b886-40bb-c028-b3de-4353e25fa462' - '403': + href: https://cloud.acquia.com/api/notifications/ea01b886-40bb-c028-b3de-4353e25fa462 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have sufficient permission to disable CDN for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not supported: value: @@ -13536,37 +14421,37 @@ paths: value: error: conflict message: Platform CDN is not enabled for this environment. - '/environments/{environmentId}/cloud-actions': + "/environments/{environmentId}/cloud-actions": get: tags: - Environments summary: Returns a list of Cloud Actions. description: Returns a list of Cloud Actions on an environment. operationId: getEnvironmentCloudActions - x-cli-name: 'environments:cloud-actions-find' + x-cli-name: environments:cloud-actions-find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/CloudActions' + $ref: "#/components/schemas/CloudActions" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27 sort: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions{?sort}' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions{?filter}' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions{?filter} templated: true _embedded: items: @@ -13579,9 +14464,9 @@ paths: default: true _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/f668295f-cbba-472d-8b75-c76ab89e553a' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/f668295f-cbba-472d-8b75-c76ab89e553a parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions - id: fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70 label: Turn on Drupal maintenance mode description: Turns on maintenance mode on the Drupal site @@ -13591,9 +14476,9 @@ paths: default: true _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70 parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions - id: 102590e4-382b-4726-8b3f-855d5ca4225d label: Clear all Drupal caches description: Clears all Drupal caches @@ -13603,31 +14488,31 @@ paths: default: false _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/102590e4-382b-4726-8b3f-855d5ca4225d' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/102590e4-382b-4726-8b3f-855d5ca4225d parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions' - '403': + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to manage Cloud Actions on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Cloud Actions unavailable: value: error: not_found @@ -13638,241 +14523,241 @@ paths: summary: Modifies an existing list of Cloud Actions. description: Modifies an existing list of Cloud Actions on an environment. operationId: putEnvironmentCloudActions - x-cli-name: 'environments:cloud-actions-update' + x-cli-name: environments:cloud-actions-update security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/PutCloudActions' + $ref: "#/components/schemas/PutCloudActions" example: cloud-actions: fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70: true 9440be70-c042-47ae-9134-e85acbbd6edf: false application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PutCloudActions' + $ref: "#/components/schemas/PutCloudActions" example: - $ref: '#/paths/~1environments~1%7BenvironmentId%7D~1cloud-actions/put/requestBody/content/application~1json/example' + $ref: "#/paths/~1environments~1%7BenvironmentId%7D~1cloud-actions/put/requestBody/content/application~1hal%2Bjson/example" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Cloud Actions have been updated. notification: 42047305-e30c-4c7e-931f-5407ce55a9e9 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27 notification: - href: 'https://cloud.acquia.com/api/notifications/42047305-e30c-4c7e-931f-5407ce55a9e9' - '403': + href: https://cloud.acquia.com/api/notifications/42047305-e30c-4c7e-931f-5407ce55a9e9 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to manage Cloud Actions on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/cloud-actions/actions/disable': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/cloud-actions/actions/disable": post: tags: - Environments summary: Disables Cloud Actions. description: Disables Cloud Actions on an environment. operationId: postEnvironmentCloudActionsDisable - x-cli-name: 'environments:cloud-actions-disable' + x-cli-name: environments:cloud-actions-disable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Cloud Actions have been disabled. notification: 2d49d11c-f81d-46dd-89f2-fb7f2f54335f _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27 notification: - href: 'https://cloud.acquia.com/api/notifications/2d49d11c-f81d-46dd-89f2-fb7f2f54335f' - '403': + href: https://cloud.acquia.com/api/notifications/2d49d11c-f81d-46dd-89f2-fb7f2f54335f + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to manage Cloud Actions on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/cloud-actions/actions/enable': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/cloud-actions/actions/enable": post: tags: - Environments summary: Enables Cloud Actions. description: Enables Cloud Actions on an environment. operationId: postEnvironmentCloudActionsEnable - x-cli-name: 'environments:cloud-actions-enable' + x-cli-name: environments:cloud-actions-enable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Cloud Actions have been enabled. notification: 003e8200-6105-48bc-80a7-6ba378ac8e91 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions/enable' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions/enable parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions notification: - href: 'https://cloud.acquia.com/api/notifications/003e8200-6105-48bc-80a7-6ba378ac8e91' - '403': + href: https://cloud.acquia.com/api/notifications/003e8200-6105-48bc-80a7-6ba378ac8e91 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to manage Cloud Actions on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/cloud-actions/actions/reset': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/cloud-actions/actions/reset": post: tags: - Environments summary: Resets Cloud Actions. description: Resets Cloud Actions to the default on an environment. operationId: postEnvironmentCloudActionsReset - x-cli-name: 'environments:cloud-actions-reset' + x-cli-name: environments:cloud-actions-reset security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Cloud Actions have been reset to the default. notification: e5a15d33-ee5a-4af1-bfeb-4e76b3d33b4b _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions/reset' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions/reset parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/cloud-actions/actions notification: - href: 'https://cloud.acquia.com/api/notifications/e5a15d33-ee5a-4af1-bfeb-4e76b3d33b4b' - '403': + href: https://cloud.acquia.com/api/notifications/e5a15d33-ee5a-4af1-bfeb-4e76b3d33b4b + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to manage Cloud Actions on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/code': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/code": post: tags: - Environments summary: Deploys code to this environment. description: Deploys code to this environment. operationId: postEnvironmentsDeployCode - x-cli-name: 'environments:code-deploy' + x-cli-name: environments:code-deploy parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/DeployCodeRequest' + $ref: "#/components/schemas/DeployCodeRequest" example: source: 14-0c7e79ab-1c4a-424e-8446-76ae8be7e851 message: Optional commit message cloud-actions: [] application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/DeployCodeRequest' + $ref: "#/components/schemas/DeployCodeRequest" example: source: 14-0c7e79ab-1c4a-424e-8446-76ae8be7e851 message: Optional commit message @@ -13880,46 +14765,46 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Code being deployed: value: message: Deploying code. _links: self: - href: 'https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/code' + href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/code notification: - href: 'https://cloud.acquia.com/api/notifications/a49eeebb-0929-444a-972c-07b94ce93ab9' + href: https://cloud.acquia.com/api/notifications/a49eeebb-0929-444a-972c-07b94ce93ab9 parent: - href: 'https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93' - '400': + href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Can only be deployed to environment within same application: value: error: validation_failed message: source: Code can only be deployed from an environment within the same application. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -13933,23 +14818,23 @@ paths: value: error: forbidden message: Code cannot be deployed on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Cannot be deployed to itself: value: @@ -13959,72 +14844,72 @@ paths: value: error: conflict message: Code deploy is not allowed on the Migrate Environment. - '/environments/{environmentId}/code/actions/switch': + "/environments/{environmentId}/code/actions/switch": post: tags: - Environments summary: Switches code on this environment to a different branch or release tag. description: Switches code on this environment to a different branch or release tag. operationId: postEnvironmentsSwitchCode - x-cli-name: 'environments:code-switch' + x-cli-name: environments:code-switch parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SwitchCodeRequest' + $ref: "#/components/schemas/SwitchCodeRequest" example: branch: my-feature-branch cloud-actions: [] application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/SwitchCodeRequest' + $ref: "#/components/schemas/SwitchCodeRequest" example: branch: my-feature-branch cloud-actions: [] security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Switching code: value: message: Switching code. _links: self: - href: 'https://cloud.acquia.com/api/environments/861-ddccebef-eb2f-48ce-a92f-e0a16a3a0b53/code/actions/switch' + href: https://cloud.acquia.com/api/environments/861-ddccebef-eb2f-48ce-a92f-e0a16a3a0b53/code/actions/switch notification: - href: 'https://cloud.acquia.com/api/notifications/bfd9a39b-a85e-4de3-8a70-042d1c7e607a' - '400': + href: https://cloud.acquia.com/api/notifications/bfd9a39b-a85e-4de3-8a70-042d1c7e607a + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Branch does not exist: value: error: validation_failed message: branch: The branch or tag "my-feature-branch" does not exist within this environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -14038,83 +14923,83 @@ paths: value: error: forbidden message: Code cannot be switched on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not allowed on a Migrate environment: value: error: conflict message: Code switch is not allowed on the Migrate Environment. - '/environments/{environmentId}/code/actions/import': + "/environments/{environmentId}/code/actions/import": post: tags: - Environments summary: Imports a site to this environment. description: Imports a site to this environment. operationId: postEnvironmentsImportSite - x-cli-name: 'environments:site-import' + x-cli-name: environments:site-import parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ImportSiteRequest' + $ref: "#/components/schemas/ImportSiteRequest" example: - url: 'http://www.example.com/path/to/site.tar.gz' + url: http://www.example.com/path/to/site.tar.gz name: Drupal 8 application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ImportSiteRequest' + $ref: "#/components/schemas/ImportSiteRequest" example: - url: 'http://www.example.com/path/to/site.tar.gz' + url: http://www.example.com/path/to/site.tar.gz name: Drupal 8 security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Site is being imported: value: message: The site is being imported. _links: self: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/code/actions/import' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/code/actions/import notification: - href: 'https://cloud.acquia.com/api/notifications/d82a122d-b7b8-46fc-9999-39cb824fac8d' - '400': + href: https://cloud.acquia.com/api/notifications/d82a122d-b7b8-46fc-9999-39cb824fac8d + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Invalid URL: value: error: validation_failed @@ -14130,34 +15015,34 @@ paths: error: validation_failed message: general: The installation file is not supported. It must be a Drush make file (.make) or a Gzip-compressed tar archive (.tar.gz or .tgz). - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to deploy code to this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: @@ -14167,44 +15052,44 @@ paths: value: error: conflict message: Site import is not allowed on the Migrate Environment. - '/environments/{environmentId}/crons': + "/environments/{environmentId}/crons": get: tags: - Environments summary: Return environment cron jobs. operationId: getCronJobsByEnvironmentId - x-cli-name: 'environments:cron-job-list' + x-cli-name: environments:cron-job-list security: - OAuth2: [] description: Returns a list of the cron jobs on an environment. parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Crons' + $ref: "#/components/schemas/Crons" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470 _embedded: items: - id: e82b77cc-a9ed-4458-b12c-d87af1a795ad server: - id: 6 + id: "18" name: web-18 command: /usr/local/bin/drush cc all - minute: '25' - hour: '7' - day_month: '*' - month: '*' - day_week: '*' + minute: "25" + hour: "7" + day_month: "*" + month: "*" + day_week: "*" label: Clear drush caches flags: enabled: true @@ -14215,17 +15100,17 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/e82b77cc-a9ed-4458-b12c-d87af1a795ad' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/e82b77cc-a9ed-4458-b12c-d87af1a795ad - id: 8eea655e-71be-4c71-bf5b-9c5c9a5c5b43 server: - id: 6 - name: web-18 + id: "6" + name: web-6 command: /usr/local/bin/drush -r /var/www/html/qa3/docroot ah-db-backup dbname - minute: '12' - hour: '9' - day_month: '*' - month: '*' - day_week: '*' + minute: "12" + hour: "9" + day_month: "*" + month: "*" + day_week: "*" label: Run backup flags: enabled: false @@ -14236,13 +15121,13 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/8eea655e-71be-4c71-bf5b-9c5c9a5c5b43' - '404': + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/8eea655e-71be-4c71-bf5b-9c5c9a5c5b43 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Non-hosted application: value: @@ -14254,50 +15139,50 @@ paths: summary: Creates a scheduled job with cron. description: Creates a scheduled job with cron on an environment. operationId: postEnvironmentCrons - x-cli-name: 'environments:cron-create' + x-cli-name: environments:cron-create parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/PostCron' + $ref: "#/components/schemas/PostCron" example: command: /usr/local/bin/drush cc all - frequency: '*/30 * * * *' + frequency: "*/30 * * * *" label: My New Cron application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PostCron' + $ref: "#/components/schemas/PostCron" example: - $ref: '#/paths/~1environments~1%7BenvironmentId%7D~1crons/post/requestBody/content/application~1json/example' + $ref: "#/paths/~1environments~1%7BenvironmentId%7D~1crons/post/requestBody/content/application~1hal%2Bjson/example" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Adding cron: value: message: Creating a new cron. _links: self: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/936a55fd-29eb-4317-bb6e-ad2a94b24589' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/936a55fd-29eb-4317-bb6e-ad2a94b24589 parent: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons notification: - href: 'https://cloud.acquia.com/api/notifications/01fde3bb-b65f-4629-b761-9072a35e8e50' - '400': + href: https://cloud.acquia.com/api/notifications/01fde3bb-b65f-4629-b761-9072a35e8e50 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Label in use: value: @@ -14309,12 +15194,12 @@ paths: error: validation_failed message: frequency: The cron frequency does not appear to be valid. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -14328,50 +15213,52 @@ paths: value: error: forbidden message: Cron jobs cannot be created on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Cron not found: value: error: not_found - message: 'The cron does not belong to this environment, and cannot be updated.' - '/environments/{environmentId}/crons/{cronId}': + message: The cron does not belong to this environment, and cannot be updated. + "/environments/{environmentId}/crons/{cronId}": get: tags: - Environments summary: Return details about a specific cron job. description: Return details about a specific cron job by environment ID and cron job ID. operationId: getCron - x-cli-name: 'environments:cron-find' + x-cli-name: environments:cron-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CronId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CronId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Cron' + $ref: "#/components/schemas/Cron" example: id: e82b77cc-a9ed-4458-b12c-d87af1a795ad - server: {} + server: + id: "18" + name: web-18 command: /usr/local/bin/drush cc all - minute: '25' - hour: '7' - day_month: '*' - month: '*' - day_week: '*' + minute: "25" + hour: "7" + day_month: "*" + month: "*" + day_week: "*" label: Clear drush caches flags: enabled: true @@ -14382,15 +15269,15 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/e82b77cc-a9ed-4458-b12c-d87af1a795ad' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons/e82b77cc-a9ed-4458-b12c-d87af1a795ad parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons' - '404': + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/crons + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Non-hosted application: value: @@ -14402,50 +15289,50 @@ paths: summary: Modify an existing scheduled job. description: Modify an existing scheduled job on an environment. operationId: putCron - x-cli-name: 'environments:cron-update' + x-cli-name: environments:cron-update parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CronId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CronId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/PutCron' + $ref: "#/components/schemas/PutCron" example: command: /usr/local/bin/drush7 cc all - frequency: '*/5 * * * *' + frequency: "*/5 * * * *" application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PutCron' + $ref: "#/components/schemas/PutCron" example: - $ref: '#/paths/~1environments~1%7BenvironmentId%7D~1crons~1%7BcronId%7D/put/requestBody/content/application~1json/example' + $ref: "#/paths/~1environments~1%7BenvironmentId%7D~1crons~1%7BcronId%7D/put/requestBody/content/application~1hal%2Bjson/example" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Update cron: value: message: Updating cron. _links: self: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/2582' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/2582 parent: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons notification: - href: 'https://cloud.acquia.com/api/notifications/ba232d96-dfe7-4850-9ca7-02e01a04f58d' - '403': + href: https://cloud.acquia.com/api/notifications/ba232d96-dfe7-4850-9ca7-02e01a04f58d + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -14459,27 +15346,27 @@ paths: value: error: forbidden message: Cron jobs are not available for Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Environment mismatch: value: error: not_found - message: 'The cron does not belong to this environment, and cannot be updated.' - '409': + message: The cron does not belong to this environment, and cannot be updated. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Label in use: value: @@ -14497,36 +15384,36 @@ paths: summary: Deletes a cron job. description: Deletes a cron job. operationId: postEnvironmentCronDelete - x-cli-name: 'environments:cron-delete' + x-cli-name: environments:cron-delete security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CronId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CronId" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Deleting cron: value: message: Deleting cron. _links: self: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1891' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1891 parent: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons notification: - href: 'https://cloud.acquia.com/api/notifications/767cee8d-05f6-4761-a3dc-755957dfc9e6' - '403': + href: https://cloud.acquia.com/api/notifications/767cee8d-05f6-4761-a3dc-755957dfc9e6 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: @@ -14540,56 +15427,56 @@ paths: value: error: forbidden message: Cron jobs are not available for Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No environment or permission: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Environment mismatch: value: error: not_found - message: 'The cron does not belong to this environment, and cannot be removed.' - '/environments/{environmentId}/crons/{cronId}/actions/enable': + message: The cron does not belong to this environment, and cannot be removed. + "/environments/{environmentId}/crons/{cronId}/actions/enable": post: tags: - Environments summary: Enables a cron job. description: Enables a cron job. operationId: postEnvironmentCronEnable - x-cli-name: 'environments:cron-enable' + x-cli-name: environments:cron-enable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CronId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CronId" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The cron is being enabled. _links: self: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1889/actions/enable' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1889/actions/enable parent: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1889/actions' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/crons/1889/actions notification: - href: 'https://cloud.acquia.com/api/notifications/ceda2e82-54b7-4181-ae97-6a3163b187b8' - '403': + href: https://cloud.acquia.com/api/notifications/ceda2e82-54b7-4181-ae97-6a3163b187b8 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: @@ -14599,67 +15486,67 @@ paths: value: error: forbidden message: Cron jobs cannot be enabled on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No cron or permission: value: error: not_found - message: 'The cron you are trying to access does not exist, or you do not have permission to access it.' + message: The cron you are trying to access does not exist, or you do not have permission to access it. Environment mismatch: value: error: not_found - message: 'The cron does not belong to this environment, and cannot be enabled.' - '409': + message: The cron does not belong to this environment, and cannot be enabled. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Action currently unavailable: value: error: conflict message: The cron is already enabled. No action taken. - '/environments/{environmentId}/crons/{cronId}/actions/disable': + "/environments/{environmentId}/crons/{cronId}/actions/disable": post: tags: - Environments summary: Disables a cron job. description: Disables a cron job. operationId: postEnvironmentCronDisable - x-cli-name: 'environments:cron-disable' + x-cli-name: environments:cron-disable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CronId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CronId" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The cron is being disabled. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/crons/1234/actions/disable' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/crons/1234/actions/disable parent: - href: 'https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/crons/1234/actions' + href: https://cloud.acquia.com/api/environments/123-af127084-204d-430c-a2b7-3a6130269b27/crons/1234/actions notification: - href: 'https://cloud.acquia.com/api/notifications/7b37b885-8ae4-454b-b8fa-ffaeff54f6a4' - '403': + href: https://cloud.acquia.com/api/notifications/7b37b885-8ae4-454b-b8fa-ffaeff54f6a4 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: @@ -14669,33 +15556,33 @@ paths: value: error: forbidden message: Cron jobs cannot be disabled on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No cron or permission: value: error: not_found - message: 'The cron you are trying to access does not exist, or you do not have permission to access it.' + message: The cron you are trying to access does not exist, or you do not have permission to access it. Environment mismatch: value: error: not_found - message: 'The cron does not belong to this environment, and cannot be disabled.' - '409': + message: The cron does not belong to this environment, and cannot be disabled. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Action currently unavailable: value: error: conflict message: The cron is already disabled. No action taken. - '/environments/{environmentId}/databases': + "/environments/{environmentId}/databases": get: tags: - Environments @@ -14711,43 +15598,43 @@ paths: * `name` * `id` operationId: getEnvironmentsDatabases - x-cli-name: 'environments:database-list' + x-cli-name: environments:database-list parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Databases' + $ref: "#/components/schemas/Databases" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases sort: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?sort}' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?filter}' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?limit}' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470 _embedded: items: - id: 14 name: my_db user_name: my_db_user password: supersecretdbpassword1! - url: 'mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db' + url: mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db db_host: dbhost.example.com ssh_host: sshhost.example.com flags: @@ -14757,12 +15644,12 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14 - id: 15 name: my_db_stage user_name: my_db_user password: supersecretdbpassword1! - url: 'mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db_stage' + url: mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db_stage db_host: dbhost.example.com ssh_host: sshhost.example.com flags: @@ -14772,18 +15659,18 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/25-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/15' - '404': + href: https://cloud.acquia.com/api/environments/25-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/15 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found @@ -14798,13 +15685,13 @@ paths: summary: Copies a database to this environment. description: Copies a database to this environment. operationId: postEnvironmentsDatabases - x-cli-name: 'environments:database-copy' + x-cli-name: environments:database-copy parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -14841,46 +15728,46 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Database being copied: value: message: The database is being copied _links: self: - href: 'https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/databases' + href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93/databases notification: - href: 'https://cloud.acquia.com/api/notifications/a49eeebb-0929-444a-972c-07b94ce93ab9' + href: https://cloud.acquia.com/api/notifications/a49eeebb-0929-444a-972c-07b94ce93ab9 parent: - href: 'https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93' - '400': + href: https://cloud.acquia.com/api/environments/24-8fc7d3c6-2a53-11e9-b210-d663bd873d93 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Database does not exist in environment: value: error: validation_failed message: database: The database does not exist in this environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -14894,23 +15781,23 @@ paths: value: error: forbidden message: Databases cannot be copied on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Cannot be copied to itself: value: @@ -14928,30 +15815,30 @@ paths: value: error: conflict message: Database copying is not allowed on the Migrate Environment. - '/environments/{environmentId}/databases/{databaseName}': + "/environments/{environmentId}/databases/{databaseName}": get: tags: - Environments summary: Return details about a specific database. description: Return details about a specific database. operationId: getEnvironmentsDatabase - x-cli-name: 'environments:database-find' + x-cli-name: environments:database-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/DatabaseName' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/DatabaseName" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Database' + $ref: "#/components/schemas/Database" example: id: 14 name: my_db user_name: my_db_user password: supersecretdbpassword1! - url: 'mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db' + url: mysql://my_db_user:supersecretdbpassword1!@dbhost.example.com/my_db db_host: dbhost.example.com ssh_host: sshhost.example.com flags: @@ -14961,28 +15848,28 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14 backups: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14/backups' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14/backups php-config: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14/php-config' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/14/php-config parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases' - '404': + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Database not found: value: error: not_found - message: 'The database you are trying to access does not exist, or you do not have permission to access it.' + message: The database you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found @@ -14991,46 +15878,49 @@ paths: value: error: not_available message: Databases do not exist on Node.js applications - '/environments/{environmentId}/databases/{databaseName}/php-config': + "/environments/{environmentId}/databases/{databaseName}/php-config": get: tags: - Environments summary: Returns PHP configuration details for this database. description: Returns PHP configuration details for this database. operationId: getEnvironmentsDatabasePhpConfig - x-cli-name: 'environments:database-php-config-find' + x-cli-name: environments:database-php-config-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/DatabaseName' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/DatabaseName" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/DatabasePhpConfig' + $ref: "#/components/schemas/DatabasePhpConfig" example: - drupal: "if (file_exists('/var/www/site-php')) {\n\trequire '/var/www/site-php/sitegroup/myenv-settings.inc';\n}" + drupal: |- + if (file_exists('/var/www/site-php')) { + require '/var/www/site-php/sitegroup/myenv-settings.inc'; + } _links: self: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/databases/mydb/php-config' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/databases/mydb/php-config parent: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/databases/mydb' - '404': + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/databases/mydb + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Database not found: value: error: not_found - message: 'The database you are trying to access does not exist, or you do not have permission to access it.' + message: The database you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found @@ -15039,7 +15929,7 @@ paths: value: error: not_available message: Databases do not exist on Node.js applications - '/environments/{environmentId}/databases/{databaseName}/backups': + "/environments/{environmentId}/databases/{databaseName}/backups": get: tags: - Environments @@ -15055,23 +15945,23 @@ paths: * `type` * `created` operationId: getEnvironmentsDatabaseBackups - x-cli-name: 'environments:database-backup-list' - parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/DatabaseName' - - $ref: '#/components/parameters/DeprecatedFrom' - - $ref: '#/components/parameters/DeprecatedTo' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' - responses: - '200': + x-cli-name: environments:database-backup-list + parameters: + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/DatabaseName" + - $ref: "#/components/parameters/DeprecatedFrom" + - $ref: "#/components/parameters/DeprecatedTo" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + responses: + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Backups' + $ref: "#/components/schemas/Backups" example: total: 2 pagination: @@ -15080,20 +15970,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups parent: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name limit: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?limit}' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?offset}' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?offset} templated: true sort: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?sort}' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?filter}' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups{?filter} templated: true _embedded: items: @@ -15111,18 +16001,18 @@ paths: name: Production _links: self: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/1' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/1 parent: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases download: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/1/actions/download' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/1/actions/download - id: 2 database: id: 14 name: db_name type: daily - started_at: '2012-03-28T12:00:00Z' - completed_at: '2012-03-28T12:00:01Z' + started_at: 2012-03-28T12:00:00Z + completed_at: 2012-03-28T12:00:01Z flags: deleted: false environment: @@ -15130,18 +16020,18 @@ paths: name: Production _links: self: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/2' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/2 parent: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases download: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/2/actions/download' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/2/actions/download - id: 3 database: id: 14 name: db_name type: daily - started_at: '2017-01-08T04:00:00Z' - completed_at: '2017-01-08T04:00:01Z' + started_at: 2017-01-08T04:00:00Z + completed_at: 2017-01-08T04:00:01Z flags: deleted: false environment: @@ -15149,18 +16039,18 @@ paths: name: Production _links: self: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/3' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/3 parent: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases download: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/3/actions/download' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/3/actions/download - id: 4 database: id: 14 name: db_name type: daily - started_at: '2017-01-08T05:00:02Z' - completed_at: '2017-01-08T05:00:03Z' + started_at: 2017-01-08T05:00:02Z + completed_at: 2017-01-08T05:00:03Z flags: deleted: false environment: @@ -15168,22 +16058,22 @@ paths: name: Production _links: self: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/4' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/4 parent: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases download: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/4/actions/download' - '404': + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name/backups/4/actions/download + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found @@ -15198,48 +16088,48 @@ paths: summary: Create a backup. description: Create a backup. operationId: postEnvironmentsDatabaseBackups - x-cli-name: 'environments:database-backup-create' + x-cli-name: environments:database-backup-create parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/DatabaseName' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/DatabaseName" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Creating backup: value: message: Creating the backup. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups/' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups/ notification: - href: 'https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c' + href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c parent: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/' - '400': + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/ + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Database does not exist in environment: value: error: validation_failed message: database: The database does not exist in this environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -15253,36 +16143,36 @@ paths: value: error: forbidden message: Database backups do not exist on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/databases/{databaseName}/backups/{backupId}': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}": get: tags: - Environments summary: Return details about a specific backup. description: Return details about a specific backup. operationId: getEnvironmentsDatabaseBackup - x-cli-name: 'environments:database-backup-find' + x-cli-name: environments:database-backup-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/DatabaseName' - - $ref: '#/components/parameters/BackupId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/DatabaseName" + - $ref: "#/components/parameters/BackupId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Backup' + $ref: "#/components/schemas/Backup" example: id: 1 database: @@ -15298,39 +16188,39 @@ paths: name: Production _links: self: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups/1' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups/1 download: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups/1/actions/download' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups/1/actions/download parent: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/database-backups _embedded: environment: id: 1-a47ac10b-58cc-4372-a567-0e02b2c3d470 name: Production _links: self: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470 database: id: 14 name: db_name _links: self: - href: 'https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name' - '404': + href: https://cloud.acquia.com/api/environments/1-a47ac10b-58cc-4372-a567-0e02b2c3d470/databases/db_name + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Database backup not found: value: error: not_found - message: 'The database backup you are trying to access does not exist, or you do not have permission to access it.' + message: The database backup you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found @@ -15345,49 +16235,49 @@ paths: summary: Deletes a database backup. description: Deletes a database backup. operationId: deleteEnvironmentsDatabaseBackup - x-cli-name: 'environments:database-backup-delete' + x-cli-name: environments:database-backup-delete parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/DatabaseName' - - $ref: '#/components/parameters/BackupId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/DatabaseName" + - $ref: "#/components/parameters/BackupId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Deleting backup: value: message: Deleting the database backup. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups/1' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups/1 notification: - href: 'https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c' + href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c parent: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups' - '400': + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/databases/my_db/backups + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Database does not exist in environment: value: error: validation_failed message: backup: The database does not exist in this environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -15401,95 +16291,82 @@ paths: value: error: forbidden message: Database backups do not exist on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Database not found: value: error: not_found - message: 'The database you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download': + message: The database you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download": get: tags: - Environments summary: Downloads the database backup file. description: Downloads the database backup file. operationId: getEnvironmentsDatabaseDownloadBackup - x-cli-name: 'environments:database-backup-download' + x-cli-name: environments:database-backup-download parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/DatabaseName' - - $ref: '#/components/parameters/BackupId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/DatabaseName" + - $ref: "#/components/parameters/BackupId" responses: - '200': + "200": description: OK content: application/octet-stream: schema: - $ref: '#/components/schemas/File' + $ref: "#/components/schemas/File" application/hal+json: schema: - $ref: '#/components/schemas/FileDownload' - example: - url: 'http://example.com/backup.gz' - expires_at: '2020-06-16T15:15:05+00:00' - _links: - self: - href: 'https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/databases/sitedatabase/backups/4423492/actions/download' - parent: - href: 'https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/databases/sitedatabase/backups/4423492/actions' - notification: - href: 'https://cloud.acquia.com/api/notifications/8a1c8503-0dae-4b08-a917-d2f01f4971ca' - application/json: - schema: - $ref: '#/components/schemas/FileDownload' + $ref: "#/components/schemas/FileDownload" example: - url: 'http://example.com/backup.gz' + url: http://example.com/backup.gz expires_at: '2020-06-16T15:15:05+00:00' _links: self: - href: 'https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/databases/sitedatabase/backups/4423492/actions/download' + href: https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/databases/sitedatabase/backups/4423492/actions/download parent: - href: 'https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/databases/sitedatabase/backups/4423492/actions' + href: https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/databases/sitedatabase/backups/4423492/actions notification: - href: 'https://cloud.acquia.com/api/notifications/8a1c8503-0dae-4b08-a917-d2f01f4971ca' + href: https://cloud.acquia.com/api/notifications/8a1c8503-0dae-4b08-a917-d2f01f4971ca text/html: schema: - $ref: '#/components/schemas/FileDownload' - '403': + $ref: "#/components/schemas/FileDownload" + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to download this backup. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Database not found: value: error: not_found - message: 'The database backup you are trying to access does not exist, or you do not have permission to access it.' + message: The database backup you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found @@ -15498,52 +16375,52 @@ paths: value: error: not_available message: Databases backups do not exist on Node.js applications - '/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore': + "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore": post: tags: - Environments summary: Restores this backup to the appropriate environment's database. description: Restores this backup to the appropriate environment's database. operationId: postEnvironmentsDatabaseRestoreBackup - x-cli-name: 'environments:database-backup-restore' + x-cli-name: environments:database-backup-restore parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/DatabaseName' - - $ref: '#/components/parameters/BackupId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/DatabaseName" + - $ref: "#/components/parameters/BackupId" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Restoring backup: value: message: Restoring the database backup. _links: self: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/databases/test_database_1/backups/4189098/actions/restore' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/databases/test_database_1/backups/4189098/actions/restore notification: - href: 'https://cloud.acquia.com/api/notifications/f295cd91-c3c0-422c-a1ab-e91fe972041a' - '400': + href: https://cloud.acquia.com/api/notifications/f295cd91-c3c0-422c-a1ab-e91fe972041a + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Does not belong to environment: value: error: validation_error message: backup: The database backup does not belong to this environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -15557,55 +16434,55 @@ paths: value: error: forbidden message: Database backups cannot be restored on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Database not found: value: error: not_found - message: 'The database you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The database you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Database not available: value: error: conflict - message: 'The database backup has not completed yet, and cannot be restored at this time.' - '/environments/{environmentId}/dns': + message: The database backup has not completed yet, and cannot be restored at this time. + "/environments/{environmentId}/dns": get: tags: - Environments summary: Returns DNS configuration details for an environment. description: Returns environment DNS configuration information for apex domain and subdomains. operationId: getEnvironmentsDns - x-cli-name: 'environments:dns-find' + x-cli-name: environments:dns-find parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Dns' + $ref: "#/components/schemas/Dns" example: apex_domain: - type: A value: 192.0.2.1 - type: AAAA - value: '2001:0db8:1729:aa03:80b5:1c65:bea:42ff' + value: 2001:0db8:1729:aa03:80b5:1c65:bea:42ff subdomains: - type: CNAME value: subdomain.example.com @@ -15614,7 +16491,7 @@ paths: - type: A value: 192.0.2.1 - type: AAAA - value: '2001:0db8:1729:aa03:80b5:1c65:bea:42ff' + value: 2001:0db8:1729:aa03:80b5:1c65:bea:42ff subdomains: - type: CNAME value: subdomain.example.com @@ -15625,27 +16502,27 @@ paths: - type: A value: 192.0.2.4 - type: AAAA - value: '2001:0db8:1730:aa03:80b5:1c65:bea:42ff' + value: 2001:0db8:1730:aa03:80b5:1c65:bea:42ff subdomains: - type: CNAME value: subdomain.example.com _links: self: - href: 'https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/dns' + href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/dns parent: - href: 'https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93' - '404': + href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/domains': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/domains": get: tags: - Environments @@ -15659,27 +16536,27 @@ paths: Sortable fields: * `hostname` operationId: getEnvironmentsDomains - x-cli-name: 'environments:domain-list' + x-cli-name: environments:domain-list parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Domains' + $ref: "#/components/schemas/Domains" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains' + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains parent: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470 _embedded: items: - hostname: www.example.com @@ -15694,9 +16571,9 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/www.example.com' + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/www.example.com status: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/www.example.com/status' + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/www.example.com/status - hostname: other.example.com cdn: null flags: @@ -15708,12 +16585,12 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/other.example.com' + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/other.example.com status: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/other.example.com/status' + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/other.example.com/status dns: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/dns' - - hostname: '*.example.com' + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/dns + - hostname: "*.example.com" cdn: status: active flags: @@ -15725,18 +16602,18 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/*.example.com' - '404': + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/domains/*.example.com + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Only available for hosted applications: value: error: not_found @@ -15747,19 +16624,19 @@ paths: summary: Adds a domain to the environment. description: Adds a domain to the environment. operationId: postEnvironmentsDomains - x-cli-name: 'environments:domain-create' + x-cli-name: environments:domain-create parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: hostname: type: string - format: uri + format: hostname description: The domain name to add. minLength: 3 maxLength: 253 @@ -15779,29 +16656,29 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Adding domain: value: message: Adding domain example.com _links: self: - href: 'https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/domains' + href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/domains notification: - href: 'https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5' + href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5 parent: - href: 'https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d' - '403': + href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -15819,23 +16696,23 @@ paths: value: error: forbidden message: Domains cannot be created on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Cannot add names to application: value: @@ -15844,12 +16721,12 @@ paths: Domain name already used: value: error: forbidden - message: 'The domain name cannot be used, as it already exists within this application''s environments.' + message: The domain name cannot be used, as it already exists within this application's environments. Error adding domain name: value: error: forbidden - message: 'This domain cannot be added to this environment. For more details, contact Acquia Support.' - '/environments/{environmentId}/domains/actions/clear-varnish': + message: This domain cannot be added to this environment. For more details, contact Acquia Support. + "/environments/{environmentId}/domains/actions/clear-varnish": post: tags: - Environments @@ -15857,13 +16734,13 @@ paths: deprecated: true description: Clears the Varnish cache for one or more domains attached to this environment. operationId: postEnvironmentsDomainsClearVarnish - x-cli-name: 'environments:domains-clear-varnish' + x-cli-name: environments:domains-clear-varnish parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: required: - domains @@ -15873,7 +16750,7 @@ paths: description: A list of domains to clear the Varnish cache for. items: type: string - format: uri + format: hostname example: domains: - domain1.example.com @@ -15881,27 +16758,27 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Clearing cache: value: message: Varnish is being cleared for the selected domains. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/actions/clear-varnish' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/actions/clear-varnish notification: - href: 'https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c' - '403': + href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -15915,35 +16792,35 @@ paths: value: error: forbidden message: Varnish cannot be cleared on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/domains/{domain}': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/domains/{domain}": get: tags: - Environments summary: Return details about a specific domain. description: Return details about a specific domain. operationId: getEnvironmentsDomain - x-cli-name: 'environments:domain-find' + x-cli-name: environments:domain-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Domain' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Domain" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Domain' + $ref: "#/components/schemas/Domain" example: hostname: example.com cdn: @@ -15957,22 +16834,22 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains/example.com' + href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains/example.com status: - href: 'https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains/example.com/status' + href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains/example.com/status parent: - href: 'https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains' - '404': + href: https://cloud.acquia.com/api/environments/24-47c9ae06-2a57-11e9-b210-d663bd873d93/domains + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Only exist on hosted applications: value: error: not_found @@ -15983,34 +16860,34 @@ paths: summary: Removes the domain from this environment. description: Removes the domain from this environment. operationId: deleteEnvironmentsDomain - x-cli-name: 'environments:domain-delete' + x-cli-name: environments:domain-delete parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Domain' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Domain" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Deleting domain: value: message: Removing the domain example.com _links: self: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/domains/example.com' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/domains/example.com notification: - href: 'https://cloud.acquia.com/api/notifications/67b7f08f-2dff-4c86-a8a0-35c4196880a3' + href: https://cloud.acquia.com/api/notifications/67b7f08f-2dff-4c86-a8a0-35c4196880a3 parent: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/domains' - '403': + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/domains + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -16024,22 +16901,22 @@ paths: value: error: forbidden message: Domains cannot be removed on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Domain not found: value: error: not_found - message: 'The domain you are trying to delete does not exist, or you do not have permission to modify it.' + message: The domain you are trying to delete does not exist, or you do not have permission to modify it. Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/domains/{domain}/actions/clear-varnish': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/domains/{domain}/actions/clear-varnish": post: tags: - Environments @@ -16047,34 +16924,34 @@ paths: deprecated: true description: Clears the Varnish cache for the specified domain. operationId: postEnvironmentsDomainClearVarnish - x-cli-name: 'environments:domain-clear-varnish' + x-cli-name: environments:domain-clear-varnish parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Domain' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Domain" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Clearing cache: value: message: Varnish is being cleared for domain 'example.com'. _links: self: - href: /environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/example.com/actions/clear-varnish + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/example.com/actions/clear-varnish notification: - href: 'https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c' - '403': + href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -16088,52 +16965,52 @@ paths: value: error: forbidden message: Varnish cannot be cleared on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/domains/{domain}/actions/clear-caches': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/domains/{domain}/actions/clear-caches": post: tags: - Environments summary: Clears the caches for the specified domain. description: Clear caches for Varnish and Platform CDN (if Platform CDN is enabled). operationId: postEnvironmentsDomainClearCaches - x-cli-name: 'environments:domain-clear-caches' + x-cli-name: environments:domain-clear-caches parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Domain' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Domain" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Clearing cache: value: message: Caches are being cleared. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/example.com/actions/clear-caches' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/domains/example.com/actions/clear-caches notification: - href: 'https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c' - '403': + href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -16147,35 +17024,35 @@ paths: value: error: forbidden message: Caches cannot be cleared on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/domains/{domain}/status': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/domains/{domain}/status": get: tags: - Environments summary: Returns details about the domain. description: Returns details about the domain. operationId: getEnvironmentsDomainStatus - x-cli-name: 'environments:domain-status-find' + x-cli-name: environments:domain-status-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Domain' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Domain" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/DomainStatus' + $ref: "#/components/schemas/DomainStatus" example: hostname: example.com flags: @@ -16192,162 +17069,162 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains/example.com/status' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains/example.com/status parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains/example.com' - '404': + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/domains/example.com + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Unable to determine status: value: error: not_found message: Unable to determine status for this domain. - '/environments/{environmentId}/eips': + "/environments/{environmentId}/eips": get: tags: - Environments summary: Return a list of Web EIPs. description: Returns a list of Web EIPs. operationId: getEIPs - x-cli-name: 'environments:eips-list' + x-cli-name: environments:eips-list parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/EIPs' + $ref: "#/components/schemas/EIPs" example: total: 1 _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470 _embedded: items: - id: f668295f-cbba-472d-8b75-c76ab89e553a status: created ipv4: 203.0.113.1 - ipv6: '0:0:0:0:0:ffff:cb00:7101' + ipv6: 0:0:0:0:0:ffff:cb00:7101 flags: active: true legacy: false deprecated: false - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/email': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/email": get: tags: - Email summary: Returns the status of Platform Email for an Environment. description: Returns the status of Platform Email for an Environment. operationId: getEmailStatus - x-cli-name: 'environments:email-status' + x-cli-name: environments:email-status parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Email' + $ref: "#/components/schemas/Email" example: status: active _links: self: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/email' + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470/email parent: - href: 'https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470' - '404': + href: https://cloud.acquia.com/api/environments/24-abcd1234-58cc-4372-a567-0e02b2c3d470 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/email/actions/disable': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/email/actions/disable": post: tags: - Environments summary: Disables email for an environment. description: Disables email for an environment. operationId: postEnvironmentEmailDisable - x-cli-name: 'environments:email-disable' + x-cli-name: environments:email-disable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Platform Email is being disabled _links: self: - href: 'https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/email/actions/disable' + href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/email/actions/disable parent: - href: 'https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/email/actions' + href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/email/actions notification: - href: 'https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000' - '403': + href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to disable email for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment mismatch: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have access to it.' - '409': + message: The environment you are trying to access does not exist, or you do not have access to it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No entitlement: value: @@ -16355,64 +17232,64 @@ paths: message: Platform Email is not available for this subscription. Not a legacy entitlement: value: - error: null + error: invalid_operation message: Platform Email cannot be disabled for this subscription. - '/environments/{environmentId}/email/actions/enable': + "/environments/{environmentId}/email/actions/enable": post: tags: - Environments summary: Enables email for an environment. description: Enables email for an environment. operationId: postEnvironmentEmailEnable - x-cli-name: 'environments:email-enable' + x-cli-name: environments:email-enable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Platform Email is being enabled _links: self: - href: 'https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/email/actions/enable' + href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/email/actions/enable parent: - href: 'https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/actions/email' + href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/actions/email notification: - href: 'https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000' - '403': + href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to enable email for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have access to it.' - '409': + message: The environment you are trying to access does not exist, or you do not have access to it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No Entitlement: value: @@ -16426,20 +17303,20 @@ paths: value: error: conflict message: There are no associated domains for this environment's application. - '/environments/{environmentId}/files': + "/environments/{environmentId}/files": post: tags: - Environments summary: Copies files to this environment. description: Copies files to this environment. operationId: postEnvironmentsFiles - x-cli-name: 'environments:file-copy' + x-cli-name: environments:file-copy parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -16460,46 +17337,46 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Files queued for copying: value: message: Copying files. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/files' + href: https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/files notification: - href: 'https://cloud.acquia.com/api/notifications/d53fccec-5c1b-4ad4-b431-5cd39ad2b453' + href: https://cloud.acquia.com/api/notifications/d53fccec-5c1b-4ad4-b431-5cd39ad2b453 parent: - href: 'https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/files' - '400': + href: https://cloud.acquia.com/api/environments/12-482e4650-1b74-44db-8d4e-e86a3b1ed908/files + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Must be within same application: value: error: validation_failed message: name: Files can only be copied from an environment within the same application. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -16513,23 +17390,23 @@ paths: value: error: forbidden message: Files cannot be copied on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Cannot be copied to itself: value: @@ -16543,30 +17420,30 @@ paths: value: error: conflict message: File copying is not allowed on the Migrate Environment. - '/environments/{environmentId}/logs': + "/environments/{environmentId}/logs": get: tags: - Environments summary: Returns a list of log files for this environment available for download. description: Returns a list of log files for this environment available for download. operationId: getEnvironmentsLogs - x-cli-name: 'environments:log-list' + x-cli-name: environments:log-list parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Logs' + $ref: "#/components/schemas/Logs" example: total: 6 _links: self: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs parent: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851 _embedded: items: - type: apache-access @@ -16575,111 +17452,108 @@ paths: available: false _links: download: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/apache-access' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/apache-access - type: apache-error label: Apache error flags: available: false _links: download: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/apache-error' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/apache-error - type: drupal-request label: Drupal request flags: available: false _links: download: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/drupal-request' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/drupal-request - type: drupal-watchdog label: Drupal watchdog flags: available: false _links: download: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/drupal-watchdog' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/drupal-watchdog - type: php-error label: PHP error flags: available: false _links: download: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/php-error' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/php-error - type: mysql-slow-query label: MySQL slow query flags: available: true _links: download: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/mysql-slow-query' - '404': + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logs/mysql-slow-query + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found message: Logs cannot be accessed on non-hosted environments. - '/environments/{environmentId}/logs/{logType}': + "/environments/{environmentId}/logs/{logType}": get: tags: - Environments summary: Downloads the log file. description: Downloads the log file. operationId: getEnvironmentsLog - x-cli-name: 'environments:log-download' + x-cli-name: environments:log-download parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/LogType' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/LogType" responses: - '200': + "200": description: OK content: application/octet-stream: schema: - $ref: '#/components/schemas/File' - application/json: + $ref: "#/components/schemas/File" + application/hal+json: schema: - $ref: '#/components/schemas/FileDownload' + $ref: "#/components/schemas/FileDownload" examples: File download: value: - url: 'http://appsiteenv.host.site-example.com/AH_DOWNLOAD?d=/mnt/gfs/appsiteenv/logs/log_type_log_appsiteenv_1574901901.sql&t=157492&env=fecac803549db0072661378f0f' - expires_at: '2019-11-30T23:21:02+00:00' - application/hal+json: - schema: - $ref: '#/components/schemas/FileDownload' + url: http://appsiteenv.host.site-example.com/AH_DOWNLOAD?d=/mnt/gfs/appsiteenv/logs/log_type_log_appsiteenv_1574901901.sql&t=157492&env=fecac803549db0072661378f0f + expires_at: 2019-11-30T23:21:02+00:00 text/html: schema: - $ref: '#/components/schemas/FileDownload' - '403': + $ref: "#/components/schemas/FileDownload" + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to download logs for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Cannot be downloaded on non-hosted applications: value: error: not_found @@ -16694,10 +17568,10 @@ paths: summary: Creates a log file snapshot. description: Creates a log file snapshot. operationId: postEnvironmentsLog - x-cli-name: 'environments:log-create' + x-cli-name: environments:log-create parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/LogType' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/LogType" requestBody: required: false content: @@ -16715,67 +17589,67 @@ paths: from: '2021-01-28T22:45:21+00:00' to: '2021-01-29T23:55:21+00:00' responses: - '201': + "201": description: Created content: application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Is being created: value: message: The log file is being created. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/logs/apache-access' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/logs/apache-access parent: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/logs' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/logs notification: - href: 'https://cloud.acquia.com/api/notifications/8b790313-8830-4810-baef-3b41b3786e9d' - '400': + href: https://cloud.acquia.com/api/notifications/8b790313-8830-4810-baef-3b41b3786e9d + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Invalid range: value: error: validation_failed message: general: Log snapshots must cover no more than 24 hours and can only be retrieved up to 30 days in the past. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to download logs for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Cannot be accessed on non-hosted applications: value: error: not_found message: Logs cannot be accessed on non-hosted environments. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Date range not supported: value: @@ -16789,73 +17663,74 @@ paths: value: error: conflict message: Log file snapshot for mysql-slow-query is not available on this environment. - '/environments/{environmentId}/logstream': + "/environments/{environmentId}/logstream": get: tags: - Environments summary: Returns a logstream url and metadata. description: Returns a logstream url and metadata. operationId: getEnvironmentsLogstream - x-cli-name: 'environments:logstream-find' + x-cli-name: environments:logstream-find parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Logstream' + $ref: "#/components/schemas/Logstream" example: logstream: - url: 'wss://logstream.example.com/ah_websocket/logstream/v1' + url: wss://logstream.example.com/ah_websocket/logstream/v1 params: t: 1516990002 hmac: d8b940bb5a1865e57b22734d541ed981c89f952e527b0a983d0e457437a43c23 environment: prod - site: 'clouduidev:qa4' + site: clouduidev:qa4 commands: - stream-environment - enable - disable _links: self: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logstream' + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851/logstream wss: - href: 'wss://logstream.example.com/ah_websocket/logstream/v1' + href: wss://logstream.example.com/ah_websocket/logstream/v1 parent: - href: 'https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851' - '404': + href: https://cloud.acquia.com/api/environments/24-0c7e79ab-1c4a-424e-8446-76ae8be7e851 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. Do not exist on non-hosted applications: value: error: not_found message: Logs cannot be accessed on non-hosted environments. - '/environments/{environmentId}/livedev/actions/disable': + "/environments/{environmentId}/livedev/actions/disable": post: tags: - Environments summary: Disable Live Development on this environment. description: Disable Live Development on this environment. + deprecated: true operationId: postEnvironmentsDisableLiveDev - x-cli-name: 'environments:livedev-disable' + x-cli-name: environments:livedev-disable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -16878,34 +17753,34 @@ paths: example: discard: 1 responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Disabling LiveDev: value: message: Disabling LiveDev. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: LiveDev cannot be disabled on production: value: error: validation_failed message: livedev: LiveDev cannot be disabled on a production environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -16923,23 +17798,23 @@ paths: value: error: forbidden message: LiveDev is not available on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: LiveDev already disabled: value: @@ -16949,35 +17824,41 @@ paths: value: error: validation_failed message: LiveDev cannot be disabled or enabled on a production environment. - '/environments/{environmentId}/livedev/actions/enable': + "/environments/{environmentId}/livedev/actions/enable": post: tags: - Environments summary: Enable Live Development on this environment. - description: Enable Live Development on this environment. + description: Enable Live Development on this environment. Not supported on Acquia Cloud Next. + deprecated: true operationId: postEnvironmentsEnableLiveDev - x-cli-name: 'environments:livedev-enable' + x-cli-name: environments:livedev-enable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/MessageWithLinks" examples: Enabling LiveDev: value: - example: Enabling LiveDev. - '400': + message: Enabling LiveDev. + _links: + self: + href: https://cloud.acquia.com/api/environments/642-99d416c4-88b5-48c0-ae8e-4719007d7b8d/livedev/actions/enable + notification: + href: https://cloud.acquia.com/api/notifications/737a97a4-4c02-47e4-9924-d008de1aa7e5 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Cannot be enabled on production: value: @@ -16989,12 +17870,12 @@ paths: error: validation_failed message: livedev: LiveDev cannot be enabled on a CD environment. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -17012,29 +17893,33 @@ paths: value: error: forbidden message: LiveDev cannot be enabled on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: LiveDev already enabled: value: error: validation_failed message: LiveDev is already enabled on this environment. - '/environments/{environmentId}/log-forwarding-destinations': + LiveDev not supported: + value: + error: conflict + message: LiveDev is not available for Cloud Next environments. + "/environments/{environmentId}/log-forwarding-destinations": get: tags: - Environments @@ -17049,37 +17934,37 @@ paths: Sortable fields: * `label` operationId: getEnvironmentsLogForwardingDestinations - x-cli-name: 'environments:log-forwarding-destination-list' + x-cli-name: environments:log-forwarding-destination-list parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/LogForwardingDestinations' + $ref: "#/components/schemas/LogForwardingDestinations" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/log-forwarding-destinations' + href: https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/log-forwarding-destinations parent: - href: 'https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a' + href: https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a _embedded: items: - uuid: df4c5428-8d2e-453d-9edf-e412647449b1 label: Test destination consumer: sumologic - address: 'example.com:1234' + address: example.com:1234 credentials: certificate: - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - expires_at: '2018-07-16T16:15:33+00:00' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + expires_at: 2018-07-16T16:15:33+00:00 key: null token: 204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5 sources: @@ -17090,20 +17975,25 @@ paths: enabled: true certificate_expiring: false health: - code: '200' + code: "200" details: Destination OK summary: OK environment: id: 123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577 name: Test + _links: + self: + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1 + parent: + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations - uuid: df4c5428-8d2e-453d-9edf-e412647449b5 label: Another test destination consumer: syslog - address: '193.169.2.19:5678' + address: 193.169.2.19:5678 credentials: certificate: - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - expires_at: '2018-07-16T16:15:33+00:00' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + expires_at: 2018-07-16T16:15:33+00:00 key: 1d0789d519c0b943cf38f401d30ffbdcd2e0c4cfb7c32ebc0c872bce62aadd4d token: 204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5 sources: @@ -17114,47 +18004,52 @@ paths: enabled: false certificate_expiring: true health: - code: '200' + code: "200" details: Destination OK summary: OK environment: id: 123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577 name: Test - '403': + _links: + self: + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b5 + parent: + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view the log forwarding destinations for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. post: tags: - Environments summary: Creates a log forwarding destination. description: Creates a log forwarding destination. operationId: postEnvironmentsLogForwardingDestinations - x-cli-name: 'environments:log-forwarding-destination-create' + x-cli-name: environments:log-forwarding-destination-create parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -17196,10 +18091,10 @@ paths: properties: certificate: type: string - description: 'A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly.' + description: A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly. key: type: string - description: 'A certificate private key associated with the consumer. Optional for Splunk, Sumologic, and Syslog. Not supported by Loggly' + description: A certificate private key associated with the consumer. Optional for Splunk, Sumologic, and Syslog. Not supported by Loggly token: type: string description: An API token associated with the consumer. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk. @@ -17214,30 +18109,30 @@ paths: - apache-error consumer: syslog credentials: - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - address: 'example.com:1234' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + address: example.com:1234 responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Log forwarding destination for the environment has been created. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/log-forwarding-destinations/95739829-0093-4673-9ee0-5f5bdac04d11' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/log-forwarding-destinations/95739829-0093-4673-9ee0-5f5bdac04d11 parent: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/log-forwarding-destinations' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/log-forwarding-destinations notification: - href: 'https://cloud.acquia.com/api/notifications/bc17cfd2-487b-4e10-b3cf-9fe1f0c10e3f' - '400': + href: https://cloud.acquia.com/api/notifications/bc17cfd2-487b-4e10-b3cf-9fe1f0c10e3f + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Log Forwarding not enabled: value: @@ -17333,66 +18228,66 @@ paths: value: error: validation_failed message: - address: 'Splunk only accepts socket addresses, consisting of a host and port.' + address: Splunk only accepts socket addresses, consisting of a host and port. Sumologic only accepts socket addresses: value: error: validation_failed message: - address: 'Sumologic only accepts socket addresses, consisting of a host and port.' + address: Sumologic only accepts socket addresses, consisting of a host and port. Syslog only accepts socket addresses: value: error: validation_failed message: - address: 'Syslog only accepts socket addresses, consisting of a host and port.' - '403': + address: Syslog only accepts socket addresses, consisting of a host and port. + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to create a log forwarding destinations for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}": get: tags: - Environments summary: Returns the specified log forwarding destination. description: Returns the specified log forwarding destination. operationId: getEnvironmentsLogForwardingDestination - x-cli-name: 'environments:log-forwarding-destination-find' + x-cli-name: environments:log-forwarding-destination-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/LogForwardingDestinationUuid' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/LogForwardingDestinationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/LogForwardingDestination' + $ref: "#/components/schemas/LogForwardingDestination" example: uuid: df4c5428-8d2e-453d-9edf-e412647449b1 label: Test destination - address: 'example.com:1234' + address: example.com:1234 consumer: syslog credentials: certificate: - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - expires_at: '2018-07-16T16:15:33+00:00' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + expires_at: 2018-07-16T16:15:33+00:00 key: 1d0789d519c0b943cf38f401d30ffbdcd2e0c4cfb7c32ebc0c872bce62aadd4d token: 204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5 sources: @@ -17403,52 +18298,57 @@ paths: enabled: true certificate_expiring: false health: - code: '200' + code: "200" details: Destination OK summary: OK environment: id: 123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577 name: Test - '403': + _links: + self: + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1 + parent: + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view the log forwarding destination. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Log Forwarding destination not found: value: error: not_found - message: 'The log forwarding destination you are trying to access does not exist, or you do not have permission to access it.' + message: The log forwarding destination you are trying to access does not exist, or you do not have permission to access it. put: tags: - Environments summary: Updates an environment's log forwarding destination. description: Updates an environment's log forwarding destination. operationId: putEnvironmentsLogForwardingDestination - x-cli-name: 'environments:log-forwarding-destination-update' + x-cli-name: environments:log-forwarding-destination-update parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/LogForwardingDestinationUuid' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/LogForwardingDestinationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -17487,10 +18387,10 @@ paths: properties: certificate: type: string - description: 'A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly.' + description: A public X.509 certificate in PEM format. Required for Splunk, Sumologic, and Syslog. Not supported by Loggly. key: type: string - description: 'A certificate private key associated with the consumer. Optional for Splunk, Sumologic, and Syslog. Not supported by Loggly' + description: A certificate private key associated with the consumer. Optional for Splunk, Sumologic, and Syslog. Not supported by Loggly token: type: string description: An API token associated with the consumer. Required by Logly and Sumologic. Optional for Syslog. Not supported by Splunk. @@ -17505,30 +18405,30 @@ paths: - apache-error consumer: syslog credentials: - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - address: 'example.com:1234' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + address: example.com:1234 responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Log forwarding destination has been updated. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/cf4c5328-8d2e-353d-9edf-e412647349b1' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/cf4c5328-8d2e-353d-9edf-e412647349b1 parent: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations notification: - href: 'https://cloud.acquia.com/api/notifications/340bf831-5377-49b9-7b26-87014b653346' - '400': + href: https://cloud.acquia.com/api/notifications/340bf831-5377-49b9-7b26-87014b653346 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Log Forwarding not enabled: value: @@ -17624,45 +18524,45 @@ paths: value: error: validation_failed message: - address: 'Splunk only accepts socket addresses, consisting of a host and port.' + address: Splunk only accepts socket addresses, consisting of a host and port. Sumologic only accepts socket addresses: value: error: validation_failed message: - address: 'Sumologic only accepts socket addresses, consisting of a host and port.' + address: Sumologic only accepts socket addresses, consisting of a host and port. Syslog only accepts socket addresses: value: error: validation_failed message: - address: 'Syslog only accepts socket addresses, consisting of a host and port.' - '403': + address: Syslog only accepts socket addresses, consisting of a host and port. + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to modify the log forwarding destination. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Log Forwarding destination not found on Environment: value: @@ -17674,176 +18574,176 @@ paths: summary: Deletes the specified log forwarding destination. description: Deletes the specified log forwarding destination. operationId: deleteEnvironmentsLogForwardingDestination - x-cli-name: 'environments:log-forwarding-destination-delete' + x-cli-name: environments:log-forwarding-destination-delete parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/LogForwardingDestinationUuid' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/LogForwardingDestinationUuid" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Log forwarding destination has been deleted. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1 parent: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations notification: - href: 'https://cloud.acquia.com/api/notifications/dfe6afd7-3619-4ab7-8aef-ab26fb506b3a' - '400': + href: https://cloud.acquia.com/api/notifications/dfe6afd7-3619-4ab7-8aef-ab26fb506b3a + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Log Forwarding not enabled: value: error: invalid_operation message: general: Destinations can only be removed from environments that have log forwarding enabled. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to delete the log forwarding destination. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Log Forwarding destination not found on Environment: value: error: invalid_operation message: The environment does not have a log forwarding destination with the UUID 2c15b578-d31a-48ac-ab28-a8ef4c65f02b. - '/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable': + "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable": post: tags: - Environments summary: Disables the specified log forwarding destination. description: Disables the specified log forwarding destination. operationId: postEnvironmentsDisableLogForwardingDestination - x-cli-name: 'environments:log-forwarding-destination-disable' + x-cli-name: environments:log-forwarding-destination-disable parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/LogForwardingDestinationUuid' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/LogForwardingDestinationUuid" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Log forwarding destination has been disabled. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1 parent: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations notification: - href: 'https://cloud.acquia.com/api/notifications/d1e9dde1-7a60-4f39-951f-295ee7fe343f' - '400': + href: https://cloud.acquia.com/api/notifications/d1e9dde1-7a60-4f39-951f-295ee7fe343f + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Log Forwarding not enabled: value: error: invalid_operation message: general: Destinations can only be disabled on environments that have log forwarding enabled. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to disable this log forwarding destination. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Log Forwarding destination already disabled: value: error: invalid_operation message: The destination is already disabled. - '/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable': + "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable": post: tags: - Environments summary: Enables the specified log forwarding destination. description: Enables the specified log forwarding destination. operationId: postEnvironmentsEnableLogForwardingDestination - x-cli-name: 'environments:log-forwarding-destination-enable' + x-cli-name: environments:log-forwarding-destination-enable parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/LogForwardingDestinationUuid' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/LogForwardingDestinationUuid" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Log forwarding destination has been enabled. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations/df4c5428-8d2e-453d-9edf-e412647449b1 parent: - href: 'https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations' + href: https://cloud.acquia.com/api/environments/123-ea9060c5-1ed8-46ec-87d5-2ce2a0861577/log-forwarding-destinations notification: - href: 'https://cloud.acquia.com/api/notifications/63a804eb-ad38-4f66-9644-725f0c04e87c' - '400': + href: https://cloud.acquia.com/api/notifications/63a804eb-ad38-4f66-9644-725f0c04e87c + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Log Forwarding not enabled: value: @@ -17870,283 +18770,287 @@ paths: error: validation_failed message: credentials: The certificate is expiring. Certificates must be valid for at least 30 days. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to enable this log forwarding destination. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Log Forwarding destination not found on Environment: value: error: invalid_operation message: The destination is already enabled. - '/environments/{environmentId}/metrics': + "/environments/{environmentId}/metrics": get: tags: - Environments summary: Does not return any data. Allows traversal to metrics groups endpoints. description: Does not return any data. Allows traversal to metrics groups endpoints. operationId: getEnvironmentsMetrics - x-cli-name: 'environments:metrics' + x-cli-name: environments:metrics parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Metrics' + $ref: "#/components/schemas/Metrics" example: _links: self: - href: 'https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics' + href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics stackmetrics: - href: 'https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics' + href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics parent: - href: 'https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a' - '403': + href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not available on Acquia Cloud Free: value: error: forbidden message: Metrics are not available to Acquia Cloud Free subscriptions. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/metrics/stackmetrics': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/metrics/stackmetrics": get: tags: - Environments summary: Does not return any data. Allows traversal to StackMetrics endpoints. description: Does not return any data. Allows traversal to StackMetrics endpoints. operationId: getEnvironmentsStackMetrics - x-cli-name: 'environments:stack-metrics-data-list' + x-cli-name: environments:stack-metrics-data-list parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Metrics' + $ref: "#/components/schemas/Metrics" example: _links: self: - href: 'https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics' + href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics data: - href: 'https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics/data' + href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics/stackmetrics/data parent: - href: 'https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics' - '403': + href: https://cloud.acquia.com/api/environments/18-185f07c7-9c4f-407b-8968-67892ebcb38a/metrics + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not available on Acquia Cloud Free: value: error: forbidden message: Metrics are not available to Acquia Cloud Free subscriptions. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/metrics/stackmetrics/data': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/metrics/stackmetrics/data": get: tags: - Environments - summary: 'Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu).' - description: 'Returns StackMetrics data for the metrics specified by the filter paramater (e.g., apache-access, web-cpu).' + summary: Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu). + description: Returns StackMetrics data for the metrics specified by the filter paramater (e.g., apache-access, web-cpu). operationId: getEnvironmentsStackMetricsData - x-cli-name: 'environments:stack-metrics-data-find' + x-cli-name: environments:stack-metrics-data-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/FilterStackMetrics' - - $ref: '#/components/parameters/FromStackMetrics' - - $ref: '#/components/parameters/ToNoDefault' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/FilterStackMetrics" + - $ref: "#/components/parameters/FromStackMetrics" + - $ref: "#/components/parameters/ToNoDefault" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/StackMetricsData' + $ref: "#/components/schemas/StackMetricsData" example: total: 4 _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/metrics/stackmetrics/data?filter=metric=db-cpu,metric=web-cpu&from=2019-06-20' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/metrics/stackmetrics/data?filter=metric=db-cpu,metric=web-cpu&from=2019-06-20 _embedded: items: - metric: db-cpu datapoints: - - - 2.5395360194838 - - 1447876380 - - - 3.3012513318685 - - 1447876680 - - - 4.568567607842 - - 1447876980 + - - "2.5395360194838" + - "1447876380" + - - "3.3012513318685" + - "1447876680" + - - "4.568567607842" + - "1447876980" + last_data_at: '2019-06-19T00:00:00+00:00' metadata: host: fsdb-1.prod.hosting.acquia.com - metric: db-cpu datapoints: - - - 22.1395360194838 - - 1447876380 - - - 23.7012513318685 - - 1447876680 - - - 24.168567607842 - - 1447876980 + - - "22.1395360194838" + - "1447876380" + - - "23.7012513318685" + - "1447876680" + - - "24.168567607842" + - "1447876980" + last_data_at: '2019-06-19T00:00:00+00:00' metadata: host: fsdb-2.prod.hosting.acquia.com - metric: web-cpu datapoints: - - - 12.1395360194838 - - 1447876380 - - - 12.7012513318685 - - 1447876680 - - - 12.168567607842 - - 1447876980 + - - "12.1395360194838" + - "1447876380" + - - "12.7012513318685" + - "1447876680" + - - "12.168567607842" + - "1447876980" + last_data_at: '2019-06-19T00:00:00+00:00' metadata: host: web-1.prod.hosting.acquia.com - metric: web-cpu datapoints: - - - 2.1395360194838 - - 1447876380 - - - 2.7012513318685 - - 1447876680 - - - 2.168567607842 - - 1447876980 + - - "2.1395360194838" + - "1447876380" + - - "2.7012513318685" + - "1447876680" + - - "2.168567607842" + - "1447876980" + last_data_at: '2019-06-19T00:00:00+00:00' metadata: host: web-2.prod.hosting.acquia.com - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not available on Acquia Cloud Free: value: error: forbidden message: Metrics are not available to Acquia Cloud Free subscriptions. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/metrics/usage': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/metrics/usage": get: tags: - Environments summary: Retrieves traversal links for an environment's usage data. description: Retrieves traversal links for an environment's usage data. operationId: getEnvironmentsUsageLinks - x-cli-name: 'environments:usage-links' + x-cli-name: environments:usage-links parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Usage' + $ref: "#/components/schemas/Usage" example: _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics data: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data views: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views visits: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' - '403': + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/metrics/usage/data': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/metrics/usage/data": get: tags: - Environments @@ -18155,40 +19059,40 @@ paths: Filterable fields: * `metric` - One of: {`views`, `visits`} operationId: getEnvironmentsUsageData - x-cli-name: 'environments:usage-data' + x-cli-name: environments:usage-data parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/EnvironmentUsageMetrics' + $ref: "#/components/schemas/EnvironmentUsageMetrics" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage filter: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data{?filter}' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/data{?filter} templated: true _embedded: items: - metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -18202,15 +19106,15 @@ paths: - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: visits datapoints: - - '2019-03-13T00:00:00+00:00' - - '3' + - "3" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -18224,60 +19128,60 @@ paths: - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/metrics/usage/{usageMetric}': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/metrics/usage/{usageMetric}": get: tags: - Environments summary: Retrieves usage metric data for an environment. description: Retrieves usage metric data for an environment. operationId: getEnvironmentsUsageMetricData - x-cli-name: 'environments:usage-metric-data' + x-cli-name: environments:usage-metric-data parameters: - - $ref: '#/components/parameters/UsageMetric' - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' + - $ref: "#/components/parameters/UsageMetric" + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/EnvironmentUsageMetric' + $ref: "#/components/schemas/EnvironmentUsageMetric" example: metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -18291,76 +19195,238 @@ paths: - 123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/environments/123-1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view pricing metric data. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Data not found: value: error: not_found - message: 'Pricing metric data for the environment with ID @id cannot be found, or you do not have access to it.' - '/environments/{environmentId}/production-mode/actions/disable': + message: Pricing metric data for the environment with ID @id cannot be found, or you do not have access to it. + "/environments/{environmentId}/mod-proxy": + get: + tags: + - Environments + summary: Returns the mod proxy status for an Environment. + description: Returns the mod proxy status for an Environment. + operationId: getModProxyStatus + x-cli-name: environments:mod-proxy-status + parameters: + - $ref: "#/components/parameters/EnvironmentId" + security: + - OAuth2: [] + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/ModProxy" + example: + status: active + _links: + self: + href: https://cloud.acquia.com/api/environments/24-eba23ecc-aa7c-41b0-8aa4-9d7ef250357d/mod-proxy + parent: + href: https://cloud.acquia.com/api/environments/24-eba23ecc-aa7c-41b0-8aa4-9d7ef250357d + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Not found: + value: + error: not_found + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": + description: Not available + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Not found: + value: + error: conflict + message: Mod proxy configuration is not available for this environment. + "/environments/{environmentId}/mod-proxy/actions/disable": + post: + tags: + - Environments + summary: Disables mod proxy for an environment. + description: Disables mod proxy for an environment. + operationId: postDisableModProxy + x-cli-name: environments:mod-proxy-disable + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/EnvironmentId" + responses: + "202": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/MessageWithLinks" + example: + _links: + self: + href: https://cloud.acquia.com/api/environments/12-5ee5d7be-ec42-4ea3-9d98-1363dcfacfd23/mod-proxy/actions/disable + message: Mod proxy is being disabled. + "403": + description: Forbidden + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + examples: + No permission: + value: + error: forbidden + message: You do not have permission to disable mod proxy for this environment. + "404": + description: Not Found + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + examples: + No subscription or permission: + value: + error: not_found + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": + description: Not available + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Not found: + value: + error: conflict + message: Mod proxy configuration is not available for this environment. + "/environments/{environmentId}/mod-proxy/actions/enable": + post: + tags: + - Environments + summary: Enables mod proxy for an environment. + description: Enables mod proxy for an environment. + operationId: postEnableModProxy + x-cli-name: environments:mod-proxy-enable + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/EnvironmentId" + responses: + "202": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/MessageWithLinks" + example: + _links: + self: + href: https://cloud.acquia.com/api/environments/12-5ee5d7be-ec42-4ea3-9d98-1363dcfacfd23/mod-proxy/actions/enable + message: Mod proxy is being enabled. + "403": + description: Forbidden + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + examples: + No permission: + value: + error: forbidden + message: You do not have permission to enable mod proxy for this environment. + "404": + description: Not Found + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + examples: + No subscription or permission: + value: + error: not_found + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": + description: Not available + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Not found: + value: + error: conflict + message: Mod proxy configuration is not available for this environment. + "/environments/{environmentId}/production-mode/actions/disable": post: tags: - Environments summary: Disables production mode for an environment. - description: 'Removes protection from a production environment, taking it out of production mode.' + description: Removes protection from a production environment, taking it out of production mode. operationId: postEnvironmentsDisableProductionMode - x-cli-name: 'environments:production-mode-disable' + x-cli-name: environments:production-mode-disable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Production mode disabled: value: message: Production mode has been disabled for this environment. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Only production can be unprotected: value: error: validation_failed message: productionmode: Only production environments can be unprotected. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -18374,69 +19440,69 @@ paths: value: error: forbidden message: Production mode is not available on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not in production mode: value: error: conflict message: This environment is not currently in production mode. - '/environments/{environmentId}/production-mode/actions/enable': + "/environments/{environmentId}/production-mode/actions/enable": post: tags: - Environments summary: Enables production mode for an environment. - description: 'Enables production mode for an environment. While production mode is enabled, files and databases cannot be copied to the production environment.' + description: Enables production mode for an environment. While production mode is enabled, files and databases cannot be copied to the production environment. operationId: postEnvironmentsEnableProductionMode - x-cli-name: 'environments:production-mode-enable' + x-cli-name: environments:production-mode-enable security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Production mode enabled: value: message: Production mode has been enabled for this environment. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Only production can be protected: value: error: validation_failed message: productionmode: Only production environments can be protected. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -18450,96 +19516,96 @@ paths: value: error: forbidden message: Production mode cannot be enabled on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already in production mode: value: error: conflict message: This environment is already in production mode. - '/environments/{environmentId}/search': + "/environments/{environmentId}/search": get: tags: - Environments summary: Returns a traversal endpoint for search entities for the environment. description: Does not return any data. Allows traversal to search entity endpoints. operationId: getEnvironmentSearchList - x-cli-name: 'environments:search:list' + x-cli-name: environments:search:list parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Search' + $ref: "#/components/schemas/Search" example: _links: self: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search parent: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905 indexes: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes' - '403': + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Forbidden: value: error: forbidden message: You do not have permission to manage search for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/search/indexes': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/search/indexes": get: tags: - Environments summary: Returns a collection of search indexes for an environment. description: A collection of search indexes for an environment. operationId: getEnvironmentSearchIndexes - x-cli-name: 'environments:search:indexes-list' + x-cli-name: environments:search:indexes-list security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Indexes' + $ref: "#/components/schemas/Indexes" example: total: 2 pagination: @@ -18548,20 +19614,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes parent: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search limit: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?limit}' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?offset}' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?offset} templated: true sort: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?sort}' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?filter}' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes{?filter} templated: true _embedded: items: @@ -18570,13 +19636,13 @@ paths: config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 database_role: example status: active - solr_version: '7' - url: 'https://example.com/solr/ABCDE-1234.test.example/' + solr_version: "7" + url: https://example.com/solr/ABCDE-1234.test.example/ _links: self: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example parent: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes _embedded: configuration_set: id: shared-1234567891011-121 @@ -18587,21 +19653,21 @@ paths: status: active _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/shared-1234567891011-121 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets - id: ABCDE-1235.test.example environment_id: 123-3f6d06a9-9236-411e-9dcc-44f0003a5905 config_set_id: ABCD5-1234.12345ab6c7e8f90g12i1jk234l56mn78 database_role: example status: active - solr_version: '7' - url: 'https://example.com/solr/ABCDE-1235.test.example/' + solr_version: "7" + url: https://example.com/solr/ABCDE-1235.test.example/ _links: self: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1235.test.example' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1235.test.example parent: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes _embedded: configuration_set: id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 @@ -18609,45 +19675,45 @@ paths: label: example-1 flags: custom: true - status: in-progress + status: pending _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' - '403': + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to view the search indexes on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. post: tags: - Environments summary: Creates a search index for an environment. description: Creates a search index for an environment. operationId: postEnvironmentSearchIndexes - x-cli-name: 'environments:search:index-create' + x-cli-name: environments:search:index-create security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -18678,51 +19744,51 @@ paths: config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 database_role: example responses: - '202': + "202": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The search index for example is being created. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example parent: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ notification: - href: 'https://cloud.acquia.com/api/notifications/5494cbe6-fe98-4cfa-877b-05bab3be3bf8' - '403': + href: https://cloud.acquia.com/api/notifications/5494cbe6-fe98-4cfa-877b-05bab3be3bf8 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to create search configuration sets on this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found or not enough permission: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Configuration set not found or not enough permission: value: error: not_found - message: 'The configuration set you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The configuration set you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Search not available: value: @@ -18740,26 +19806,26 @@ paths: value: error: validation_failed message: The configuration set is not available for this environment. - '/environments/{environmentId}/search/indexes/{indexId}': + "/environments/{environmentId}/search/indexes/{indexId}": get: tags: - Environments summary: Returns a search configuration set for an application description: A specific search configuration set. operationId: getEnvironmentSearchIndex - x-cli-name: 'environments:search:index-find' + x-cli-name: environments:search:index-find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/IndexId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/IndexId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Index' + $ref: "#/components/schemas/Index" example: id: ABCDE-1234.test.example environment_id: 123-3f6d06a9-9236-411e-9dcc-44f0003a5905 @@ -18770,13 +19836,13 @@ paths: code: OK summary: Search index active details: No issues. - solr_version: '7' - url: 'https://example.com/solr/ABCDE-1234.test.example/' + solr_version: "7" + url: https://example.com/solr/ABCDE-1234.test.example/ _links: self: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example parent: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes _embedded: configuration_set: id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 @@ -18784,52 +19850,52 @@ paths: label: example-1 flags: custom: true - status: in-progress + status: pending _links: self: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78' + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets/ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 parent: - href: 'https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets' - '403': + href: https://cloud.acquia.com/api/applications/3f6d06a9-9236-411e-9dcc-44f0003a5905/search/config-sets + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to view the search indexes on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No environment or not enough permissions: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. No index or not enough permissions: value: error: not_found - message: 'The search index you are trying to access does not exist, or you do not have permission to access it.' + message: The search index you are trying to access does not exist, or you do not have permission to access it. put: tags: - Environments summary: Updates a search index on an environment. description: Updates a search index on an environment. operationId: putEnvironmentSearchIndex - x-cli-name: 'environments:search:index-update' + x-cli-name: environments:search:index-update security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/IndexId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/IndexId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -18848,45 +19914,45 @@ paths: example: config_set_id: ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78 responses: - '202': + "202": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The search index ABCDE-1234.test.example is being updated. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example parent: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ notification: - href: 'https://cloud.acquia.com/api/notifications/a0733378-eee4-4c29-bc2d-dea85e17b1aa' - '403': + href: https://cloud.acquia.com/api/notifications/a0733378-eee4-4c29-bc2d-dea85e17b1aa + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to make a change in a search index on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Search not available: value: @@ -18902,62 +19968,62 @@ paths: summary: Removes and deletes a specific search index from an environment description: Removes and deletes a specific search index from an environment operationId: deleteEnvironmentSearchIndex - x-cli-name: 'environments:search:index-delete' + x-cli-name: environments:search:index-delete security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/IndexId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/IndexId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The search index has been removed from the environment. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ABCDE-1234.test.example parent: - href: 'https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/' + href: https://cloud.acquia.com/api/environments/123-3f6d06a9-9236-411e-9dcc-44f0003a5905/search/indexes/ notification: - href: 'https://cloud.acquia.com/api/notifications/d64552a2-7e3e-46af-b2a0-b122aae26a7d' - '403': + href: https://cloud.acquia.com/api/notifications/d64552a2-7e3e-46af-b2a0-b122aae26a7d + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to delete search indexes on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or not enough permissions: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Search index not available: value: error: not_found message: The search index is not available to this environment. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: validation_failed message: Acquia Search is not available for this subscription. - '/environments/{environmentId}/servers': + "/environments/{environmentId}/servers": get: tags: - Environments @@ -18979,32 +20045,32 @@ paths: * `ip` * `status` operationId: getEnvironmentsServers - x-cli-name: 'environments:servers-list' + x-cli-name: environments:servers-list parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Servers' + $ref: "#/components/schemas/Servers" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470 _embedded: items: - - id: '6' + - id: 6 name: ded-6 hostname: ded-6.servers.acquia.com ssh_user: user.dev @@ -19015,6 +20081,7 @@ paths: - web - db ami_type: c1.medium + operating_system: xenial configuration: memcache: 64 ecu: 5 @@ -19036,17 +20103,18 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/6' - - id: '4' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/6 + - id: 4 name: bal-4 hostname: bal-4.servers.acquia.com - ssh_user: null + ssh_user: user.dev ip: 10.0.0.2 status: normal region: us-west-1 roles: - bal ami_type: m1.small + operating_system: xenial configuration: memcache: null ecu: 1 @@ -19068,18 +20136,18 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/4' - '404': + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/4 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Not available on non-hosted applications: value: error: not_found @@ -19096,28 +20164,28 @@ paths: value: error: not_available message: Servers cannot be viewed on Node.js applications. - '/environments/{environmentId}/servers/{serverId}': + "/environments/{environmentId}/servers/{serverId}": get: tags: - Environments summary: Return details about a specific server. description: Return details about a specific server. operationId: getEnvironmentsServer - x-cli-name: 'environments:server-find' + x-cli-name: environments:server-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/ServerId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/ServerId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Server' + $ref: "#/components/schemas/Server" example: - id: '6' + id: 6 name: ded-6 hostname: ded-6.servers.acquia.com ssh_user: user.dev @@ -19150,20 +20218,20 @@ paths: name: dev _links: self: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/6' + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/servers/6 parent: - href: 'https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470' - '404': + href: https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Not available on non-hosted applications: value: error: not_found @@ -19186,14 +20254,14 @@ paths: summary: Modifies configuration settings for a server. description: Modifies configuration settings for a server. operationId: putEnvironmentsServer - x-cli-name: 'environments:server-update' + x-cli-name: environments:server-update parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/ServerId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/ServerId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -19218,34 +20286,34 @@ paths: security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Server configuration being updated: value: message: The server configuration is being updated. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: No options set to update: value: error: validation_failed message: general: No configuration options were set to update. No action performed. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Cannot be configured for free tier: value: @@ -19263,17 +20331,17 @@ paths: value: error: not_available message: Server configuration cannot be modified on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' + message: The application you are trying to access does not exist, or you do not have permission to access it. Cannot be configured for CDEs: value: error: not_available @@ -19286,36 +20354,36 @@ paths: value: error: not_found message: The server with ID 42 does not exist in this application. - '/environments/{environmentId}/servers/{serverId}/actions/reboot': + "/environments/{environmentId}/servers/{serverId}/actions/reboot": post: tags: - Environments summary: Reboots a server. description: Reboots a server. This will cause all applications on this server to be unavailable while the server reboots. operationId: postEnvironmentsServerReboot - x-cli-name: 'environments:server-reboot' + x-cli-name: environments:server-reboot parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/ServerId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/ServerId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Server is being rebooted: value: message: The server is being rebooted. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Only Acquia Cloud Professional can be rebooted: value: @@ -19332,12 +20400,12 @@ paths: error: validation_failed message: general: CD environments cannot be rebooted. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -19355,21 +20423,21 @@ paths: value: error: not_available message: Servers cannot be rebooted on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Server not found: value: error: not_found - message: 'The server you are trying to access does not exist, or you do not have permission to access it.' + message: The server you are trying to access does not exist, or you do not have permission to access it. Not available on CDEs: value: error: not_available @@ -19378,36 +20446,36 @@ paths: value: error: not_found message: The server with ID 42 does not exist in this application. - '/environments/{environmentId}/servers/{serverId}/actions/relaunch': + "/environments/{environmentId}/servers/{serverId}/actions/relaunch": post: tags: - Environments summary: Relaunches a server. description: Relaunches a server. This will cause all applications on this server to be unavailable while the server relaunches. operationId: postEnvironmentsServerRelaunch - x-cli-name: 'environments:server-relaunch' + x-cli-name: environments:server-relaunch parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/ServerId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/ServerId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Server is being relaunched: value: message: The server is being relaunched. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Only Acquia Cloud Professional can be relaunched: value: @@ -19424,12 +20492,12 @@ paths: error: validation_failed message: general: CD environments cannot be relaunched. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -19447,21 +20515,21 @@ paths: value: error: not_available message: Servers cannot be relaunched on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Server not found: value: error: not_found - message: 'The server you are trying to access does not exist, or you do not have permission to access it.' + message: The server you are trying to access does not exist, or you do not have permission to access it. Not available on CDEs: value: error: not_available @@ -19470,36 +20538,36 @@ paths: value: error: not_found message: The server with ID 42 does not exist in this application. - '/environments/{environmentId}/servers/{serverId}/actions/suspend': + "/environments/{environmentId}/servers/{serverId}/actions/suspend": post: tags: - Environments summary: Suspends a server. description: Suspends a server. The server will no longer respond to web requests. operationId: postEnvironmentsServerSuspend - x-cli-name: 'environments:server-suspend' + x-cli-name: environments:server-suspend parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/ServerId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/ServerId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Server is being suspended: value: message: The server is being suspended. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Only Acquia Cloud Professional can be suspended: value: @@ -19516,12 +20584,12 @@ paths: error: validation_failed message: general: CD environments cannot be suspended. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -19539,21 +20607,21 @@ paths: value: error: not_available message: Servers cannot be suspended on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Server not found: value: error: not_found - message: 'The server you are trying to access does not exist, or you do not have permission to access it.' + message: The server you are trying to access does not exist, or you do not have permission to access it. Not available on CDEs: value: error: not_available @@ -19562,36 +20630,36 @@ paths: value: error: not_found message: The server with ID 42 does not exist in this application. - '/environments/{environmentId}/servers/{serverId}/actions/upgrade': + "/environments/{environmentId}/servers/{serverId}/actions/upgrade": post: tags: - Environments summary: Upgrades a server from "precise" to "xenial". description: Upgrades a server from "precise" to "xenial". operationId: postEnvironmentsServerUpgrade - x-cli-name: 'environments:server-upgrade' + x-cli-name: environments:server-upgrade parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/ServerId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/ServerId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Server is being upgraded: value: message: The server is being upgraded. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Only Acquia Cloud Professional can be upgraded: value: @@ -19613,12 +20681,12 @@ paths: error: validation_failed message: general: Only servers running "precise" may be upgraded. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -19636,21 +20704,21 @@ paths: value: error: not_available message: Servers cannot be upgraded on Node.js applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Server not found: value: error: not_found - message: 'The server you are trying to access does not exist, or you do not have permission to access it.' + message: The server you are trying to access does not exist, or you do not have permission to access it. Not available on CDEs: value: error: not_available @@ -19659,43 +20727,43 @@ paths: value: error: not_found message: The server with ID 42 does not exist in this application. - '/environments/{environmentId}/settings': + "/environments/{environmentId}/settings": get: tags: - Environments summary: Provides links to environment settings. description: Provides links to environment settings. operationId: getEnvironmentsSettings - x-cli-name: 'environments:settings' + x-cli-name: environments:settings parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/EnvironmentSettings' + $ref: "#/components/schemas/EnvironmentSettings" example: _links: self: - href: 'https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123/settings' + href: https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123/settings apm: - href: 'https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123/settings/apm' + href: https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123/settings/apm parent: - href: 'https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123' - '404': + href: https://cloud.acquia.com/api/environments/24-12345678-abcd-4372-a567-0e02b2c3a123 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/settings/apm': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/settings/apm": get: tags: - Application Performance Monitoring Services @@ -19703,16 +20771,16 @@ paths: summary: Returns a list of Application Performance Monitoring services associated with the environment. description: Returns a list of Application Performance Monitoring services associated with the environment. operationId: getEnvironmentsApmSetting - x-cli-name: 'environments:apm-find' + x-cli-name: environments:apm-find parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Apm' + $ref: "#/components/schemas/Apm" example: type: newrelic key: 123456789abcdef037dea2e355bc43987a123456 @@ -19721,34 +20789,34 @@ paths: enabled: true _links: self: - href: 'https://cloud.acquia.com/api/environments/6-252031e4-59f0-7914-95a5-ff83699fdcde/settings/apm' + href: https://cloud.acquia.com/api/environments/6-252031e4-59f0-7914-95a5-ff83699fdcde/settings/apm _embedded: environment: - _links: self: - href: 'https://cloud.acquia.com/api/environments/6-252031e4-59f0-7914-95a5-ff83699fdcde' - '403': + href: https://cloud.acquia.com/api/environments/6-252031e4-59f0-7914-95a5-ff83699fdcde + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not available: value: error: forbidden message: APM settings are not available for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Not available on non-hosted applications: value: error: not_found @@ -19760,19 +20828,19 @@ paths: summary: Update configuration for an Application Performance Monitoring tool. description: Update configuration for an Application Performance Monitoring tool. operationId: putEnvironmentsApmSetting - x-cli-name: 'environments:apm-update' + x-cli-name: environments:apm-update parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: status: type: boolean - description: 'Whether the APM tool should be enabled or disabled. If updating an existing install, this value does not need to be provided.' + description: Whether the APM tool should be enabled or disabled. If updating an existing install, this value does not need to be provided. type: type: string description: The APM tool to install. Required if installing or updating a configuration. @@ -19790,7 +20858,7 @@ paths: properties: status: type: boolean - description: 'Whether the APM tool should be enabled or disabled. If updating an existing install, this value does not need to be provided.' + description: Whether the APM tool should be enabled or disabled. If updating an existing install, this value does not need to be provided. type: type: string description: The APM tool to install. Required if installing or updating a configuration. @@ -19803,22 +20871,33 @@ paths: type: newrelic key: Some New Relic key responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Settings are being updated: value: message: APM settings are being updated for this environment. - '403': + "400": + description: Bad Request + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Validation failed: + value: + error: bad_request + message: APM names may only contain alphanumeric, dashes, dots, colons, underscores and space characters. + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -19836,36 +20915,36 @@ paths: value: error: forbidden message: Please contact support to modify APM settings for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/ssl': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/ssl": get: tags: - Environments summary: Returns the SSL settings for this environment. description: Returns the SSL settings for this environment. operationId: getSsl - x-cli-name: 'environments:ssl-settings-find' + x-cli-name: environments:ssl-settings-find parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Ssl' + $ref: "#/components/schemas/Ssl" example: balancer: hostname: example.us-east-1.elb.amazonaws.com @@ -19873,66 +20952,66 @@ paths: - 127.0.0.1 _links: self: - href: 'https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl' + href: https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl certificates: - href: 'https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl/certificates' + href: https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl/certificates csrs: - href: 'https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl/csrs' + href: https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2/ssl/csrs parent: - href: 'https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2' - '403': + href: https://cloud.acquia.com/api/environments/3-110075c3-126e-6b43-c2ce-30be75fb33c2 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not available for free tier: value: error: not_found message: SSL certificates are not available to Acquia Cloud Free subscriptions. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '/environments/{environmentId}/ssl/certificates': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "/environments/{environmentId}/ssl/certificates": get: tags: - Environments summary: Return a list of SSL certificates. description: Returns the SSL certificates that are installed on this environment. operationId: getCertificates - x-cli-name: 'environments:certificate-list' + x-cli-name: environments:certificate-list parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Certificates' + $ref: "#/components/schemas/Certificates" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates' + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates parent: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl' + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl _embedded: items: - id: 7 label: null - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - private_key: null - ca: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + private_key: -----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY----- + ca: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- flags: active: true csr: true @@ -19946,14 +21025,14 @@ paths: name: prod _links: self: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/7' + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/7 csr: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/7' + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/7 - id: 3 label: Test Certificate 1 - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----' - ca: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + private_key: -----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY----- + ca: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- flags: active: true csr: false @@ -19967,12 +21046,12 @@ paths: name: prod _links: self: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/3' + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/3 - id: 4 label: Test Certificate 2 - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----' - ca: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + private_key: -----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY----- + ca: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- flags: active: false csr: true @@ -19986,13 +21065,13 @@ paths: name: prod _links: self: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/4' - '404': + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/4 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Non-hosted application: value: @@ -20004,64 +21083,64 @@ paths: summary: Install an SSL certificate. description: Install a new SSL certificate on this environment. operationId: postCertificate - x-cli-name: 'environments:certificate-create' + x-cli-name: environments:certificate-create parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/PostCertificate' + $ref: "#/components/schemas/PostCertificate" example: legacy: false - certificate: '-----BEGIN CERTIFICATE-----abc123....-----END CERTIFICATE-----' - private_key: '-----BEGIN RSA PRIVATE KEY-----secret....-----END RSA PRIVATE KEY-----' - ca_certificates: '-----BEGIN CERTIFICATE-----123abc....-----END CERTIFICATE-----' + certificate: -----BEGIN CERTIFICATE-----abc123....-----END CERTIFICATE----- + private_key: -----BEGIN RSA PRIVATE KEY-----secret....-----END RSA PRIVATE KEY----- + ca_certificates: -----BEGIN CERTIFICATE-----123abc....-----END CERTIFICATE----- csr_id: 123 label: My New Cert application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PostCertificate' + $ref: "#/components/schemas/PostCertificate" example: - $ref: '#/paths/~1environments~1%7BenvironmentId%7D~1ssl~1certificates/post/requestBody/content/application~1json/example' + $ref: "#/paths/~1environments~1%7BenvironmentId%7D~1ssl~1certificates/post/requestBody/content/application~1hal%2Bjson/example" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Site is being imported: value: message: Installing the certificate. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl/certificates' + href: https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl/certificates notification: - href: 'https://cloud.acquia.com/api/notifications/8fdacf25-38e4-4621-b5de-e78638fe2ceb' + href: https://cloud.acquia.com/api/notifications/8fdacf25-38e4-4621-b5de-e78638fe2ceb parent: - href: 'https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl' - '400': + href: https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Cannot install: value: error: system message: Unable to install a certificate on environment ID 5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4. Site certificate CA chain certificates are out of order or contain unused certificates. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not on Acquia Cloud Free: value: @@ -20075,23 +21154,23 @@ paths: value: error: forbidden message: You do not have permission to manage SSL certificates on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Invalid country code: value: @@ -20103,32 +21182,32 @@ paths: error: validation_failed message: domain: The domain invalid does not appear to be a valid domain name. - '/environments/{environmentId}/ssl/certificates/{certificateId}': + "/environments/{environmentId}/ssl/certificates/{certificateId}": get: tags: - Environments summary: Returns a specific certificate by certificate id. description: Returns details about a specific SSL certificate. operationId: getCertificate - x-cli-name: 'environments:certificate-find' + x-cli-name: environments:certificate-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CertificateId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CertificateId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Certificate' + $ref: "#/components/schemas/Certificate" example: id: 13 label: Test Certificate - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' - private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----' - ca: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- + private_key: -----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY----- + ca: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- flags: active: true csr: true @@ -20142,15 +21221,15 @@ paths: name: prod _links: self: - href: 'https://cloud.acquia.com/api/environments/5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4/ssl/certificates/13' + href: https://cloud.acquia.com/api/environments/5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4/ssl/certificates/13 parent: - href: 'https://cloud.acquia.com/api/environments/5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4/ssl/certificates' - '404': + href: https://cloud.acquia.com/api/environments/5-9d46fd9d-e58b-47a3-8e9e-e8e0c2a854b4/ssl/certificates + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Non-hosted application: value: @@ -20162,34 +21241,34 @@ paths: summary: Deletes a specific certificate by its ID. description: Deletes a specific certificate by its ID. operationId: deleteCertificate - x-cli-name: 'environments:certificate-delete' + x-cli-name: environments:certificate-delete parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CertificateId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CertificateId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Deleting the certificate. _links: self: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/9' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/9 parent: - href: 'https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates' + href: https://cloud.acquia.com/api/environments/286-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates notification: - href: 'https://cloud.acquia.com/api/notifications/767cee8d-05f6-4761-a3dc-755957dfc9e6' - '403': + href: https://cloud.acquia.com/api/notifications/767cee8d-05f6-4761-a3dc-755957dfc9e6 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not on Acquia Cloud Free: value: @@ -20203,66 +21282,66 @@ paths: value: error: forbidden message: SSL certificates are not available on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No environment or permission: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Incorrect certificate: value: error: not_found - message: 'This certificate does not belong to the environment, and cannot be removed.' - '409': + message: This certificate does not belong to the environment, and cannot be removed. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Not on Acquia Cloud Free: value: error: validation_failed message: general: The currently active certificate cannot be removed. - '/environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate': + "/environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate": post: tags: - Environments summary: Activates an SSL certificate. description: Activates an SSL certificate. operationId: postActivateCertificate - x-cli-name: 'environments:certificate-activate' + x-cli-name: environments:certificate-activate parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CertificateId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CertificateId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Activating the certificate. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/1/actions/activate' + href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/1/actions/activate notification: - href: 'https://cloud.acquia.com/api/notifications/4ee513c7-13b4-459f-af60-ba50c4f7cb5d' - '400': + href: https://cloud.acquia.com/api/notifications/4ee513c7-13b4-459f-af60-ba50c4f7cb5d + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Only installable on production: value: @@ -20294,12 +21373,12 @@ paths: error: validation_failed message: private_key: The supplied private key is invalid. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not on Acquia Cloud Free: value: @@ -20313,27 +21392,27 @@ paths: value: error: forbidden message: SSL certificates cannot be activated on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found or no permission: value: error: forbidden - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Incorrect certificate: value: error: forbidden - message: 'This certificate does not belong to the environment, and cannot be set to active.' - '409': + message: This certificate does not belong to the environment, and cannot be set to active. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Legacy certificate: value: @@ -20345,51 +21424,51 @@ paths: error: validation_failed message: general: This certificate is already set as active. - '/environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate': + "/environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate": post: tags: - Environments summary: Deactivates an active SSL certificate. description: Deactivates an active SSL certificate. operationId: postDeactivateCertificate - x-cli-name: 'environments:certificate-deactivate' + x-cli-name: environments:certificate-deactivate parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CertificateId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CertificateId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Deactivating the certificate. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/4547/actions/deactivate' + href: https://cloud.acquia.com/api/environments/123-a027502b-ad6c-a48e-a7e8-aa0def7d25e1/ssl/certificates/4547/actions/deactivate notification: - href: 'https://cloud.acquia.com/api/notifications/cb5de18e-5721-4c26-9f67-1a7d806dd09e' - '400': + href: https://cloud.acquia.com/api/notifications/cb5de18e-5721-4c26-9f67-1a7d806dd09e + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Legacy certificate: value: error: validation_failed message: - general: 'Legacy certificates cannot be deactivated. In order to deactivate a legacy certificate, the certificate must be removed.' - '403': + general: Legacy certificates cannot be deactivated. In order to deactivate a legacy certificate, the certificate must be removed. + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not on Acquia Cloud Free: value: @@ -20403,61 +21482,61 @@ paths: value: error: forbidden message: SSL certificates cannot be deactivated on non-hosted applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found or no permission: value: error: forbidden - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Incorrect certificate: value: error: forbidden - message: 'This certificate does not belong to the environment, and cannot be deactivated.' - '409': + message: This certificate does not belong to the environment, and cannot be deactivated. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already active: value: error: validation_failed message: This certificate is already deactivated. - '/environments/{environmentId}/ssl/csrs': + "/environments/{environmentId}/ssl/csrs": get: tags: - Environments summary: Returns certificate signing requests. description: Returns the certificate signing requests for this environment. operationId: getCertificateSigningRequests - x-cli-name: 'environments:csr-find' + x-cli-name: environments:csr-find parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Certificates' + $ref: "#/components/schemas/CertificateSigningRequests" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/ssl/csrs' + href: https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/ssl/csrs parent: - href: 'https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/ssl' + href: https://cloud.acquia.com/api/environments/5-185f07c7-9c4f-407b-8968-67892ebcb38a/ssl _embedded: items: - - id: '7' - csr: '-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----' - private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----' + - id: 7 + csr: -----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST----- + private_key: -----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY----- country: US state: Massachusetts locality: Boston @@ -20475,12 +21554,12 @@ paths: name: prod _links: self: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/7' + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/7 certificate: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/7' - - id: '8' - csr: '-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----' - private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----' + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/7 + - id: 8 + csr: -----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST----- + private_key: -----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY----- country: US state: Massachusetts locality: Boston @@ -20496,15 +21575,15 @@ paths: name: prod _links: self: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/8' + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/csrs/8 certificate: - href: 'https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/8' - '404': + href: https://cloud.acquia.com/api/environments/5-a1a10dab-62f4-418c-bc58-ab7742078ba8/ssl/certificates/8 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Non-hosted application: value: @@ -20516,15 +21595,15 @@ paths: summary: Generates a certificate signing request (CSR) for one or more domains. description: Generates a CSR for one or more domains. operationId: postCertificateSigningRequest - x-cli-name: 'environments:csr-create' + x-cli-name: environments:csr-create parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/PostCsr' + $ref: "#/components/schemas/PostCsr" example: country: CA state: Ontario @@ -20537,33 +21616,33 @@ paths: - www3.example.com application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PostCsr' + $ref: "#/components/schemas/PostCsr" example: - $ref: '#/paths/~1environments~1%7BenvironmentId%7D~1ssl~1csrs/post/requestBody/content/application~1json/example' + $ref: "#/paths/~1environments~1%7BenvironmentId%7D~1ssl~1csrs/post/requestBody/content/application~1hal%2Bjson/example" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: A CSR is being generated for the selected domain. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl/csrs' + href: https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl/csrs parent: - href: 'https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl' + href: https://cloud.acquia.com/api/environments/123-4ba86d4a-e193-4282-8963-d9d24746f444/ssl notification: - href: 'https://cloud.acquia.com/api/notifications/8fdacf25-38e4-4621-b5de-e78638fe2ceb' - '403': + href: https://cloud.acquia.com/api/notifications/8fdacf25-38e4-4621-b5de-e78638fe2ceb + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not on Acquia Cloud Free: value: @@ -20577,27 +21656,27 @@ paths: value: error: forbidden message: You do not have permission to manage SSL certificates on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Incorrect certificate: value: error: forbidden - message: 'This certificate signing request does not belong to the environment, and cannot be used to install a certificate.' - '409': + message: This certificate signing request does not belong to the environment, and cannot be used to install a certificate. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Legacy certificate: value: @@ -20654,30 +21733,30 @@ paths: error: validation_failed message: ca_certificates: Intermediate certificate Example Certificate has expired. - '/environments/{environmentId}/ssl/csrs/{certificateId}': + "/environments/{environmentId}/ssl/csrs/{certificateId}": get: tags: - Environments summary: Returns the certificate signing request for the certificate specified by id. description: Returns details about a specific certificate signing request. operationId: getCertificateSigningRequest - x-cli-name: 'environments:csr-find' + x-cli-name: environments:csr-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CertificateId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CertificateId" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/CertificateSigningRequest' + $ref: "#/components/schemas/CertificateSigningRequest" example: - id: '7' - csr: '-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----' - private_key: '-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----' + id: 7 + csr: -----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST----- + private_key: -----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY----- country: US state: Massachusetts locality: Boston @@ -20695,17 +21774,17 @@ paths: name: prod _links: self: - href: 'https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs/7' + href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs/7 certificate: - href: 'https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/certificates/7' + href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/certificates/7 parent: - href: 'https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs' - '403': + href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not on Acquia Cloud Free: value: @@ -20715,21 +21794,21 @@ paths: value: error: forbidden message: You do not have permission to view Certificate Signing Requests on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No environment or permission: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. No CSR or permission: value: error: not_found - message: 'The CSR you are trying to access does not exist, or you do not have permission to access it.' + message: The CSR you are trying to access does not exist, or you do not have permission to access it. Non-hosted application: value: error: not_found @@ -20740,46 +21819,46 @@ paths: summary: Deletes the certificate signing request. description: Deletes the certificate signing request for the certificate specified by id. operationId: deleteCertificateSigningRequest - x-cli-name: 'environments:csr-delete' + x-cli-name: environments:csr-delete parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/CertificateId' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/CertificateId" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: Deleting the certificate signing request. _links: self: - href: 'https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs/7' + href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs/7 parent: - href: 'https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs' + href: https://cloud.acquia.com/api/environments/5-aeb8e8a6-0eef-4a1e-8d8d-545e025b12a5/ssl/csrs notification: - href: 'https://cloud.acquia.com/api/notifications/87c0f979-2f84-4b88-bc5e-8c1670fd2f01' - '400': + href: https://cloud.acquia.com/api/notifications/87c0f979-2f84-4b88-bc5e-8c1670fd2f01 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Not on Acquia Cloud Free: value: error: validation_failed message: - general: 'This certificate signing request is used for a certificate, and cannot be removed.' - '403': + general: This certificate signing request is used for a certificate, and cannot be removed. + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not on Acquia Cloud Free: value: @@ -20789,22 +21868,22 @@ paths: value: error: forbidden message: You do not have permission to delete Certificate Signing Requests on this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No environment or permission: value: error: not_found - message: 'The environment you are trying to administer does not exist, or you do not have permission to administer it.' + message: The environment you are trying to administer does not exist, or you do not have permission to administer it. Incorrect certificate signing request: value: error: not_found - message: 'This certificate signing request does not belong to the environment, and cannot be removed.' - '/environments/{environmentId}/variables': + message: This certificate signing request does not belong to the environment, and cannot be removed. + "/environments/{environmentId}/variables": get: tags: - Environments @@ -20818,75 +21897,75 @@ paths: Sortable fields: * `name` operationId: getEnvironmentsVariables - x-cli-name: 'environments:variable-list' + x-cli-name: environments:variable-list parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/EnvironmentVariables' + $ref: "#/components/schemas/EnvironmentVariables" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/environment/24-569086da-2b1f-11e9-b210-d663bd873d93/variables' + href: https://cloud.acquia.com/api/environment/24-569086da-2b1f-11e9-b210-d663bd873d93/variables sort: - href: 'https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?sort}' + href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?filter}' + href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?limit}' + href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93' + href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93 _embedded: items: - name: variable_one value: Sample Value One _links: self: - href: 'https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_one' + href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_one - name: variable_two value: Sample Value Two _links: self: - href: 'https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_two' + href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_two - name: variable_three value: Sample Value Three _links: self: - href: 'https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_three' - '403': + href: https://cloud.acquia.com/api/environments/24-569086da-2b1f-11e9-b210-d663bd873d93/variables/variable_three + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view environment variables for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Not available on managed applications: value: error: not_available @@ -20901,13 +21980,13 @@ paths: summary: Adds a new environment variable to an environment. description: Adds a new environment variable to an environment. operationId: postEnvironmentsVariables - x-cli-name: 'environments:variable-create' + x-cli-name: environments:variable-create parameters: - - $ref: '#/components/parameters/EnvironmentId' + - $ref: "#/components/parameters/EnvironmentId" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -20916,7 +21995,7 @@ paths: description: The name of the environment variable to add. minLength: 1 maxLength: 255 - pattern: '^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$' + pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$ value: type: string description: The value of the environment variable to add. @@ -20934,7 +22013,7 @@ paths: description: The name of the environment variable to add. minLength: 1 maxLength: 255 - pattern: '^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$' + pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$ value: type: string description: The value of the environment variable to add. @@ -20944,51 +22023,51 @@ paths: name: APP_KEY value: aaaabbbbccccddddeee responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Variable is being added: value: message: The environment variable is being added. _links: self: - href: 'https://cloud.acquia.com/api/environments/123-c7056b9e-0fb7-44e9-a434-426a404211c1/variables' + href: https://cloud.acquia.com/api/environments/123-c7056b9e-0fb7-44e9-a434-426a404211c1/variables notification: - href: 'https://cloud.acquia.com/api/notifications/f3c2bdc1-60c1-48af-8777-996477f901d5' + href: https://cloud.acquia.com/api/notifications/f3c2bdc1-60c1-48af-8777-996477f901d5 parent: - href: 'https://cloud.acquia.com/api/environments/123-c7056b9e-0fb7-44e9-a434-426a404211c1' - '400': + href: https://cloud.acquia.com/api/environments/123-c7056b9e-0fb7-44e9-a434-426a404211c1 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Invalid variable name: value: error: validation_failed message: - name: 'The environment variable name is invalid. It must contain only letters, numbers, and underscores; it cannot start with a number, AH_, or ACQUIA_; and it must be under 256 characters long.' + name: The environment variable name is invalid. It must contain only letters, numbers, and underscores; it cannot start with a number, AH_, or ACQUIA_; and it must be under 256 characters long. Invalid value: value: error: not_available message: - value: 'The environment variable value is invalid: it must be less than 256 characters long.' + value: "The environment variable value is invalid: it must be less than 256 characters long." Variable name already exists: value: error: not_available message: name: The environment already has an environment variable with that name. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -20998,84 +22077,84 @@ paths: value: error: not_available message: Environment variables are not available for Service Management-enabled applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Not available on Acquia Cloud Site Factory: value: error: not_available message: Environment variables are not available for Acquia Cloud Site Factory applications. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not available: value: error: conflict message: Environment variables are not available for this environment. - '/environments/{environmentId}/variables/{environmentVariableName}': + "/environments/{environmentId}/variables/{environmentVariableName}": get: tags: - Environments summary: Get an environment variable associated with this environment. description: Get an environment variable associated with this environment. operationId: getEnvironmentsVariable - x-cli-name: 'environments:variable-find' + x-cli-name: environments:variable-find parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/EnvironmentVariableName' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/EnvironmentVariableName" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/EnvironmentVariable' + $ref: "#/components/schemas/EnvironmentVariable" example: name: variable_one value: Sample Value One _links: self: - href: 'https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables/variable_one' + href: https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables/variable_one parent: - href: 'https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables' - '403': + href: https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view environment variables for this environment. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' + message: The environment you are trying to access does not exist, or you do not have permission to access it. Environment variable not found: value: error: not_found - message: 'The environment variable you are trying to access does not exist, or you do not have permission to access it.' + message: The environment variable you are trying to access does not exist, or you do not have permission to access it. Not available on managed applications: value: error: not_available @@ -21090,46 +22169,46 @@ paths: summary: Removes an environment variable from an environment. description: Removes an environment variable from an environment. operationId: deleteEnvironmentsVariable - x-cli-name: 'environments:variable-delete' + x-cli-name: environments:variable-delete parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/EnvironmentVariableName' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/EnvironmentVariableName" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Variable is being removed: value: message: The environment variable is being removed. _links: self: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/variables/EXAMPLE_VARIABLE_NAME' + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/variables/EXAMPLE_VARIABLE_NAME notification: - href: 'https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c' + href: https://cloud.acquia.com/api/notifications/42b56cff-0b55-4bdf-a949-1fd0fca61c6c parent: - href: 'https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/variables' - '400': + href: https://cloud.acquia.com/api/environments/12-d314739e-296f-11e9-b210-d663bd873d93/variables + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Invalid value: value: error: validation_failed message: name: The environment does not have an environment variable with that name. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -21138,28 +22217,28 @@ paths: Environment variable not found: value: error: not_found - message: 'The environment variable you are trying to access does not exist, or you do not have permission to access it.' + message: The environment variable you are trying to access does not exist, or you do not have permission to access it. Not available on managed applications: value: error: not_available message: Environment variables are not available for Service Management-enabled applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not available: value: @@ -21171,14 +22250,14 @@ paths: summary: Updates an environment variable on an environment. description: Updates an environment variable on an environment. operationId: putEnvironmentsVariable - x-cli-name: 'environments:variable-update' + x-cli-name: environments:variable-update parameters: - - $ref: '#/components/parameters/EnvironmentId' - - $ref: '#/components/parameters/EnvironmentVariableName' + - $ref: "#/components/parameters/EnvironmentId" + - $ref: "#/components/parameters/EnvironmentVariableName" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -21190,13 +22269,14 @@ paths: description: The name of the environment variable to add. minLength: 1 maxLength: 255 - pattern: '^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$' + pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$ value: type: string description: The value of the environment variable to add. minLength: 0 maxLength: 255 example: + name: APP_KEY value: aaaabbbbccccddddeee application/x-www-form-urlencoded: schema: @@ -21210,7 +22290,7 @@ paths: description: The name of the environment variable to add. minLength: 1 maxLength: 255 - pattern: '^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$' + pattern: ^(?!(ACQUIA_|AH_))[A-Za-z_][A-Za-z0-9_]*$ value: type: string description: The value of the environment variable to add. @@ -21220,46 +22300,46 @@ paths: name: APP_KEY value: aaaabbbbccccddddeee responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: Variable is being updated: value: message: The environment variable is being updated. _links: self: - href: 'https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables/name' + href: https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables/name notification: - href: 'https://cloud.acquia.com/api/notifications/37c8646c-bbe8-423a-970b-cbeb530b981d' + href: https://cloud.acquia.com/api/notifications/37c8646c-bbe8-423a-970b-cbeb530b981d parent: - href: 'https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables' - '400': + href: https://cloud.acquia.com/api/environments/24-734b7960-2b1f-11e9-b210-d663bd873d93/variables + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Invalid value: value: error: validation_failed message: - value: 'The environment variable value is invalid: it must be less than 5000 characters long.' + value: "The environment variable value is invalid: it must be less than 5000 characters long." Variable name already exists: value: error: validation_failed message: name: The environment already has an environment variable with that name. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: @@ -21268,67 +22348,67 @@ paths: Environment variable not found: value: error: not_found - message: 'The environment variable you are trying to access does not exist, or you do not have permission to access it.' + message: The environment variable you are trying to access does not exist, or you do not have permission to access it. Not available on managed applications: value: error: not_available message: Environment variables are not available for Service Management-enabled applications. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Environment not found: value: error: not_found - message: 'The environment you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The environment you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not available: value: error: conflict message: Environment variables are not available for this environment. - '/ides/{ideUuid}': + "/ides/{ideUuid}": get: tags: - Cloud IDE summary: Returns Cloud IDE info. description: Returns Cloud IDE info. operationId: getIde - x-cli-name: 'ide:find' + x-cli-name: ide:find parameters: - - $ref: '#/components/parameters/IdeUuid' + - $ref: "#/components/parameters/IdeUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Ide' + $ref: "#/components/schemas/Ide" example: uuid: 215824ff-272a-4a8c-9027-df32ed1d68a9 label: Example IDE status: active _links: self: - href: 'https://cloud.acquia.com/api/ides/215824ff-272a-4a8c-9027-df32ed1d68a9' + href: https://cloud.acquia.com/api/ides/215824ff-272a-4a8c-9027-df32ed1d68a9 parent: - href: 'https://cloud.acquia.com/api/ides' + href: https://cloud.acquia.com/api/ides application: - href: 'https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199' + href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199 web: - href: 'https://ide-215824ff-272a-4a8c-9027-df32ed1d68a9.prod.acquia-sites.com' + href: https://ide-215824ff-272a-4a8c-9027-df32ed1d68a9.prod.acquia-sites.com ide: - href: 'https://215824ff-272a-4a8c-9027-df32ed1d68a9.ides.acquia.com' + href: https://215824ff-272a-4a8c-9027-df32ed1d68a9.ides.acquia.com _embedded: owner: uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd @@ -21337,59 +22417,59 @@ paths: last_login_at: '2019-01-31T10:53:11-05:00' created_at: '2016-08-14T17:38:59-04:00' email: user.name@example.com - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The IDE you are trying to access does not exist, or you do not have permission to access it.' + message: The IDE you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Cloud IDE summary: De-provisions a specific Cloud IDE. description: De-provisions a specific Cloud IDE. operationId: deleteIde - x-cli-name: 'ide:delete' + x-cli-name: ide:delete parameters: - - $ref: '#/components/parameters/IdeUuid' + - $ref: "#/components/parameters/IdeUuid" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" examples: De-provisioning IDE: value: message: The Cloud IDE is being deleted. _links: self: - href: 'https://cloud.acquia.com/api/ides/215824ff-272a-4a8c-9027-df32ed1d68a9' + href: https://cloud.acquia.com/api/ides/215824ff-272a-4a8c-9027-df32ed1d68a9 parent: - href: 'https://cloud.acquia.com/api/ides' + href: https://cloud.acquia.com/api/ides notification: - href: 'https://cloud.acquia.com/api/notifications/e98577df-840a-4fef-8775-66cf90b3530e' - '404': + href: https://cloud.acquia.com/api/notifications/e98577df-840a-4fef-8775-66cf90b3530e + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The IDE you are trying to access does not exist, or you do not have permission to access it.' + message: The IDE you are trying to access does not exist, or you do not have permission to access it. /identity-providers: get: tags: @@ -21404,21 +22484,21 @@ paths: Sortable fields: * `label` operationId: getIdentityProviders - x-cli-name: 'identity-providers:list' + x-cli-name: identity-providers:list parameters: - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IdentityProviders' + $ref: "#/components/schemas/IdentityProviders" example: total: 2 pagination: @@ -21427,109 +22507,109 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers parent: - href: 'https://cloud.acquia.com/api/' + href: https://cloud.acquia.com/api/ filter: - href: 'https://cloud.acquia.com/api/identity-providers{?filter}' + href: https://cloud.acquia.com/api/identity-providers{?filter} templated: true sort: - href: 'https://cloud.acquia.com/api/identity-providers{?sort}' + href: https://cloud.acquia.com/api/identity-providers{?sort} templated: true limit: - href: 'https://cloud.acquia.com/api/identity-providers{?limit}' + href: https://cloud.acquia.com/api/identity-providers{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/identity-providers{?offset}' + href: https://cloud.acquia.com/api/identity-providers{?offset} templated: true _embedded: items: - uuid: 5fa84b25-a269-44bd-a2ae-e76d08ac8245 label: Identity provider label - idp_entity_id: 'https://idp.example.com/saml' - sp_entity_id: 'https://sp.example.com/saml' - sso_url: 'https://example.com/sso' - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' + idp_entity_id: https://idp.example.com/saml + sp_entity_id: https://sp.example.com/saml + sso_url: https://example.com/sso + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- status: enabled _links: self: - href: 'https://cloud.acquia.com/api/identity-providers/5fa84b25-a269-44bd-a2ae-e76d08ac8245' + href: https://cloud.acquia.com/api/identity-providers/5fa84b25-a269-44bd-a2ae-e76d08ac8245 parent: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers acs: - href: 'https://accounts.acquia.com/api/auth/saml/acs/5fa84b25-a269-44bd-a2ae-e76d08ac8245' + href: https://accounts.acquia.com/api/auth/saml/acs/5fa84b25-a269-44bd-a2ae-e76d08ac8245 - uuid: 908914ec-2354-4fb1-9298-637247eccc3a label: Identity provider label 2 - idp_entity_id: 'https://idp2.example.com/saml' - sp_entity_id: 'https://sp2.example.com/saml' - sso_url: 'https://example.com/sso' - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' + idp_entity_id: https://idp2.example.com/saml + sp_entity_id: https://sp2.example.com/saml + sso_url: https://example.com/sso + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- status: enabled _links: self: - href: 'https://cloud.acquia.com/api/identity-providers/908914ec-2354-4fb1-9298-637247eccc3a' + href: https://cloud.acquia.com/api/identity-providers/908914ec-2354-4fb1-9298-637247eccc3a parent: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers acs: - href: 'https://accounts.acquia.com/api/auth/saml/acs/908914ec-2354-4fb1-9298-637247eccc3a' - '/identity-providers/{identityProviderUuid}': + href: https://accounts.acquia.com/api/auth/saml/acs/908914ec-2354-4fb1-9298-637247eccc3a + "/identity-providers/{identityProviderUuid}": get: tags: - Identity Providers summary: Returns a specific identity provider by UUID. description: Returns a specific identity provider. operationId: getIdentityProvider - x-cli-name: 'identity-providers:find' + x-cli-name: identity-providers:find parameters: - - $ref: '#/components/parameters/IdentityProviderUuid' + - $ref: "#/components/parameters/IdentityProviderUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IdentityProvider' + $ref: "#/components/schemas/IdentityProvider" example: uuid: 1bc5dbb4-6d59-403b-afc7-777e520aaa40 label: Test identity provider - idp_entity_id: 'https://idp.example.com/saml' - sp_entity_id: 'https://sp.example.com/saml' - sso_url: 'https://example.com/sso' - certificate: '-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----' + idp_entity_id: https://idp.example.com/saml + sp_entity_id: https://sp.example.com/saml + sso_url: https://example.com/sso + certificate: -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- status: enabled _links: self: - href: 'https://cloud.acquia.com/api/identity-providers/1bc5dbb4-6d59-403b-afc7-777e520aaa40' + href: https://cloud.acquia.com/api/identity-providers/1bc5dbb4-6d59-403b-afc7-777e520aaa40 parent: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers acs: - href: 'https://accounts.acquia.com/api/auth/saml/acs/1bc5dbb4-6d59-403b-afc7-777e520aaa40' + href: https://accounts.acquia.com/api/auth/saml/acs/1bc5dbb4-6d59-403b-afc7-777e520aaa40 organization: - href: 'https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34' - '404': + href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The identity provider you are trying to access does not exist, or you do not have permission to access it.' + message: The identity provider you are trying to access does not exist, or you do not have permission to access it. put: tags: - Identity Providers summary: Modifies an identity provider by its UUID. description: Modifies an identity provider. operationId: putIdentityProvider - x-cli-name: 'identity-providers:update' + x-cli-name: identity-providers:update parameters: - - $ref: '#/components/parameters/IdentityProviderUuid' + - $ref: "#/components/parameters/IdentityProviderUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -21549,8 +22629,8 @@ paths: example: label: New label entity_id: entity-id - sso_url: 'https://idp.example.com' - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' + sso_url: https://idp.example.com + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- application/x-www-form-urlencoded: schema: type: object @@ -21571,38 +22651,38 @@ paths: example: label: New label entity_id: entity-id - sso_url: 'https://idp.example.com' - certificate: '-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----' + sso_url: https://idp.example.com + certificate: -----BEGIN CERTIFICATE-----...-----END CERTIFICATE----- security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: Identity Provider has been updated. _links: self: - href: 'https://cloud.acquia.com/api/identity-providers/8030f025-47dc-4926-940b-0b04d98d1ea2' + href: https://cloud.acquia.com/api/identity-providers/8030f025-47dc-4926-940b-0b04d98d1ea2 parent: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers notification: - href: 'https://cloud.acquia.com/api/notifications/29dcc1e2-3cfc-447c-9fcb-d51c1c26b4da' - '400': + href: https://cloud.acquia.com/api/notifications/29dcc1e2-3cfc-447c-9fcb-d51c1c26b4da + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: No Parameters: value: error: validation_failed message: - general: 'No update executed, as no parameters were provided. Please update at least one property.' + general: No update executed, as no parameters were provided. Please update at least one property. Invalid Certificate: value: error: validation_failed @@ -21623,26 +22703,26 @@ paths: error: validation_failed message: credentials: The certificate is expiring. Certificates must be valid for at least 90 days. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to edit the identity provider. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not Found or Does Not Exist: 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.' + message: The identity provider you are trying to access does not exist, or you do not have permission to access it. Does Not Exist: value: error: not_found @@ -21651,12 +22731,12 @@ paths: value: error: not_found message: An organization with associated identity provider UUID idp1234-aaaa-1234-abcd-0123456789ab cannot be found. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already Enabled and Active: value: @@ -21672,184 +22752,184 @@ paths: summary: Deletes a specific identity provider by its UUID. description: Deletes a specific identity provider. operationId: deleteIdentityProvider - x-cli-name: 'identity-providers:delete' + x-cli-name: identity-providers:delete parameters: - - $ref: '#/components/parameters/IdentityProviderUuid' + - $ref: "#/components/parameters/IdentityProviderUuid" security: - OAuth2: [] responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Identity provider has been deleted. _links: self: - href: 'https://cloud.acquia.com/api/identity-providers/da1c0a8e-ff69-45db-88fc-acd6d2affbb7' + href: https://cloud.acquia.com/api/identity-providers/da1c0a8e-ff69-45db-88fc-acd6d2affbb7 parent: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers notification: - href: 'https://cloud.acquia.com/api/notifications/29dcc1e2-3cfc-447c-9fcb-d51c1c26b4da' - '403': + href: https://cloud.acquia.com/api/notifications/29dcc1e2-3cfc-447c-9fcb-d51c1c26b4da + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: forbidden message: You do not have permission to delete the identity provider. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not Found or Does Not Exist: 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.' + message: The identity provider you are trying to access does not exist, or you do not have permission to access it. No Associated Organization: value: error: not_found message: An organization with associated identity provider UUID da1c0a8e-ff69-45db-88fc-acd6d2affbb7 cannot be found. - '/identity-providers/{identityProviderUuid}/actions/enable': + "/identity-providers/{identityProviderUuid}/actions/enable": post: tags: - Identity Providers summary: Enables an identity provider by its UUID. description: Enables an identity provider. operationId: postEnableIdentityProvider - x-cli-name: 'identity-providers:enable' + x-cli-name: identity-providers:enable parameters: - - $ref: '#/components/parameters/IdentityProviderUuid' + - $ref: "#/components/parameters/IdentityProviderUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Identity Provider has been enabled. _links: self: - href: 'https://cloud.acquia.com/api/identity-providers/e1851cef-aa3c-4153-bb81-1c25fcf7dc77' + href: https://cloud.acquia.com/api/identity-providers/e1851cef-aa3c-4153-bb81-1c25fcf7dc77 parent: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers notification: - href: 'https://cloud.acquia.com/api/notifications/31660dfd-def7-49f0-b1f2-847fa267a021' - '403': + href: https://cloud.acquia.com/api/notifications/31660dfd-def7-49f0-b1f2-847fa267a021 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: conflict message: You do not have permission to enable this identity provider. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: conflict - message: 'The identity provider you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The identity provider you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already enabled: value: error: conflict message: The identity provider is already enabled. - '/identity-providers/{identityProviderUuid}/actions/disable': + "/identity-providers/{identityProviderUuid}/actions/disable": post: tags: - Identity Providers summary: Disables an identity provider by its UUID. description: Disables an identity provider. operationId: postDisableIdentityProvider - x-cli-name: 'identity-providers:disable' + x-cli-name: identity-providers:disable parameters: - - $ref: '#/components/parameters/IdentityProviderUuid' + - $ref: "#/components/parameters/IdentityProviderUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Identity Provider has been disabled. _links: self: - href: 'https://cloud.acquia.com/api/identity-providers/e1851cef-aa3c-4153-bb81-1c25fcf7dc77' + href: https://cloud.acquia.com/api/identity-providers/e1851cef-aa3c-4153-bb81-1c25fcf7dc77 parent: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers notification: - href: 'https://cloud.acquia.com/api/notifications/31660dfd-def7-49f0-b1f2-847fa267a021' - '403': + href: https://cloud.acquia.com/api/notifications/31660dfd-def7-49f0-b1f2-847fa267a021 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: conflict message: You do not have permission to disable this identity provider. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: conflict - message: 'The identity provider you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The identity provider you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already disabled: value: error: conflict message: The identity provider is already disabled. - '/invites/{token}': + "/invites/{token}": get: tags: - Invite summary: Returns details about an invitation. description: Returns details about an invitation. operationId: getInviteByToken - x-cli-name: 'invites:find' + x-cli-name: invites:find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/Token' + - $ref: "#/components/parameters/Token" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Invite' + $ref: "#/components/schemas/Invite" example: applications: - uuid: 7659fe2a-7322-4132-a4b7-0795f1246a54 @@ -21863,7 +22943,7 @@ paths: last_login_at: '2019-01-30T08:58:07-05:00' created_at: '2015-08-14T17:37:23-04:00' mail: joe.smith@example.com - picture_url: 'https://accounts.acquia.com/images/users/2429bf71-9145-4266-b532-1f4e3beaed55/style/avatar' + picture_url: https://accounts.acquia.com/images/users/2429bf71-9145-4266-b532-1f4e3beaed55/style/avatar username: joe.smith organization: uuid: d258dc23-90c5-447c-b550-981b469796d9 @@ -21882,235 +22962,235 @@ paths: declined: false _links: self: - href: 'https://cloud.acquia.com/api/invites/189d2089-c7f1-418c-a437-9676f4edb1b3' - '403': + href: https://cloud.acquia.com/api/invites/189d2089-c7f1-418c-a437-9676f4edb1b3 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No invite or permission: value: error: unauthorized message: You do not have permission to access this resource. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No invite or permission: value: error: not_found - message: 'The invite you are trying to view does not exist, or you do not have permission to view it.' + message: The invite you are trying to view does not exist, or you do not have permission to view it. delete: tags: - Invite summary: Cancels an invitation. description: Cancels an invitation. operationId: postInviteCancel - x-cli-name: 'invites:cancel' + x-cli-name: invites:cancel security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/Token' + - $ref: "#/components/parameters/Token" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Cancelled invite: value: message: Cancelled invite. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No invite or permission: value: error: unauthorized message: You do not have permission to access this resource. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No invite or permission: value: error: not_found - message: 'The invite you are trying to view does not exist, or you do not have permission to view it.' - '/invites/{token}/actions/accept': + message: The invite you are trying to view does not exist, or you do not have permission to view it. + "/invites/{token}/actions/accept": post: tags: - Invite summary: Accepts an invite. description: Accepts an invite. operationId: postInviteAcceptByToken - x-cli-name: 'invites:accept' + x-cli-name: invites:accept security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/Token' + - $ref: "#/components/parameters/Token" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Accepted invite: value: message: The invite has been accepted. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Validation failed: value: error: not_found - message: 'The invite you are trying to accept does not exist, or you do not have permission to accept it.' - '409': + message: The invite you are trying to accept does not exist, or you do not have permission to accept it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already accepted: value: error: conflict message: This invite has already been accepted. - '/invites/{token}/actions/decline': + "/invites/{token}/actions/decline": post: tags: - Invite summary: Declines an invite. description: Declines an invite. operationId: postInviteDecline - x-cli-name: 'invites:decline' + x-cli-name: invites:decline security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/Token' + - $ref: "#/components/parameters/Token" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Declined invite: value: message: The invite has been declined. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Validation failed: value: error: not_found - message: 'The invite you are trying to decline does not exist, or you do not have permission to decline it.' - '409': + message: The invite you are trying to decline does not exist, or you do not have permission to decline it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Already declined: value: error: conflict message: This invite has already been declined. - '/invites/{token}/actions/resend': + "/invites/{token}/actions/resend": post: tags: - Invite summary: Resend an invite. description: Resend an invite. operationId: postInviteResend - x-cli-name: 'invites:resend' + x-cli-name: invites:resend security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/Token' + - $ref: "#/components/parameters/Token" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Declined invite: value: message: Resent invitation. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Validation failed: value: error: not_found - message: 'The invite you are trying to resent does not exist, or you do not have permission to resent it.' - '/messages/{messageUuid}/actions/dismiss': + message: The invite you are trying to resent does not exist, or you do not have permission to resent it. + "/messages/{messageUuid}/actions/dismiss": post: tags: - Messages summary: Dismisses a message. description: Dismisses a message. operationId: postDismissMessage - x-cli-name: 'messages:dismiss' + x-cli-name: messages:dismiss parameters: - - $ref: '#/components/parameters/MessageUuid' + - $ref: "#/components/parameters/MessageUuid" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Site revoked: value: message: Message dismissed. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission or message: value: error: forbidden - message: 'The message you are trying to dismiss does not exist, or you do not have permission to access it.' - '409': + message: The message you are trying to dismiss does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Message already dismissed: value: @@ -22120,54 +23200,54 @@ paths: value: error: conflict message: This message cannot be dismissed. - '/messages/{messageUuid}/actions/follow': + "/messages/{messageUuid}/actions/follow": get: tags: - Messages summary: Follows an in-product message link. description: Follows an in-product message link. operationId: getMessageFollow - x-cli-name: 'messages:follow' + x-cli-name: messages:follow parameters: - - $ref: '#/components/parameters/MessageUuid' + - $ref: "#/components/parameters/MessageUuid" responses: - '301': + "301": description: Moved Permanently headers: Location: schema: type: string description: The redirect destination URL. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No application or permission: value: error: not_found - message: 'The message you are trying to follow the link for does not exist, or you do not have permission to access it.' - '/notifications/{notificationUuid}': + message: The message you are trying to follow the link for does not exist, or you do not have permission to access it. + "/notifications/{notificationUuid}": get: tags: - Notifications summary: Returns a single notification. description: Returns a single notification. operationId: getNotificationByUuid - x-cli-name: 'notifications:find' + x-cli-name: notifications:find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/NotificationUuid' + - $ref: "#/components/parameters/NotificationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Notification' + $ref: "#/components/schemas/Notification" example: uuid: 1bd3487e-71d1-4fca-a2d9-5f969b3d35c1 event: ApplicationAddedToRecents @@ -22186,20 +23266,20 @@ paths: - 5391a8a9-d273-4f88-8114-7f884bbfe08b _links: self: - href: 'https://cloud.acquia.com/api/notifications/1bd3487e-71d1-4fca-a2d9-5f969b3d35c1' + href: https://cloud.acquia.com/api/notifications/1bd3487e-71d1-4fca-a2d9-5f969b3d35c1 parent: - href: 'https://cloud.acquia.com/api/notifications' - '404': + href: https://cloud.acquia.com/api/notifications + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No data or permission: value: error: not_found - message: 'The data you are trying to access does not exist, or you do not have permission to access it.' + message: The data you are trying to access does not exist, or you do not have permission to access it. /options: get: tags: @@ -22207,24 +23287,24 @@ paths: summary: Does not return any data. Allows traversal of options groups endpoints. description: Does not return any data. Allows traversal of options groups endpoints. operationId: getOptions - x-cli-name: 'options:list' + x-cli-name: options:list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" example: _links: self: - href: 'https://cloud.acquia.com/api/options' + href: https://cloud.acquia.com/api/options cde-sizes: - href: 'https://cloud.acquia.com/api/options/cde-sizes' + href: https://cloud.acquia.com/api/options/cde-sizes log-forwarding: - href: 'https://cloud.acquia.com/api/options/log-forwarding' + href: https://cloud.acquia.com/api/options/log-forwarding /options/cde-sizes: get: tags: @@ -22232,21 +23312,21 @@ paths: summary: Displays the various CD Environment size options. description: Displays the various CD Environment size options. operationId: getCdeSizes - x-cli-name: 'options:cde-sizes-list' + x-cli-name: options:cde-sizes-list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/CdeSizes' + $ref: "#/components/schemas/CdeSizes" example: total: 5 _links: self: - href: 'https://cloud.acquia.com/api/options/cde-sizes' + href: https://cloud.acquia.com/api/options/cde-sizes parent: - href: 'https://cloud.acquia.com/api/options' + href: https://cloud.acquia.com/api/options _embedded: items: - name: 1X @@ -22286,24 +23366,24 @@ paths: summary: Does not return any data. Allows traversal of options groups endpoints. description: Does not return any data. Allows traversal of options groups endpoints. operationId: getLogForwarding - x-cli-name: 'options:log-forwarding' + x-cli-name: options:log-forwarding responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: properties: _links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" example: _links: self: - href: 'https://cloud.acquia.com/api/options/log-forwarding' + href: https://cloud.acquia.com/api/options/log-forwarding sources: - href: 'https://cloud.acquia.com/api/options/log-forwarding/sources' + href: https://cloud.acquia.com/api/options/log-forwarding/sources consumers: - href: 'https://cloud.acquia.com/api/options/log-forwarding/consumers' + href: https://cloud.acquia.com/api/options/log-forwarding/consumers /options/log-forwarding/sources: get: tags: @@ -22311,21 +23391,21 @@ paths: summary: Displays available log forwarding sources. description: Displays available log forwarding sources. operationId: getLogForwardingSources - x-cli-name: 'options:log-forwarding-source-list' + x-cli-name: options:log-forwarding-source-list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/LogForwardingSources' + $ref: "#/components/schemas/LogForwardingSources" example: total: 1 _links: self: - href: 'https://cloud.acquia.com/api/log-forwarding/sources' + href: https://cloud.acquia.com/api/log-forwarding/sources parent: - href: 'https://cloud.acquia.com/api/log-forwarding' + href: https://cloud.acquia.com/api/log-forwarding _embedded: items: - name: apache-access @@ -22339,21 +23419,21 @@ paths: summary: Displays available log forwarding consumers. description: Displays available log forwarding consumers. operationId: getLogForwardingConsumers - x-cli-name: 'options:log-forwarding-consumer-list' + x-cli-name: options:log-forwarding-consumer-list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/LogForwardingConsumers' + $ref: "#/components/schemas/LogForwardingConsumers" example: total: 1 _links: self: - href: 'https://cloud.acquia.com/api/log-forwarding/consumers' + href: https://cloud.acquia.com/api/log-forwarding/consumers parent: - href: 'https://cloud.acquia.com/api/log-forwarding' + href: https://cloud.acquia.com/api/log-forwarding _embedded: items: - name: sumologic @@ -22365,32 +23445,32 @@ paths: summary: Displays the various color options. description: Displays the various color options. operationId: getColors - x-cli-name: 'colors:list' + x-cli-name: colors:list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Colors' + $ref: "#/components/schemas/Colors" example: total: 10 _links: self: - href: 'https://cloud.acquia.com/api/options/colors' + href: https://cloud.acquia.com/api/options/colors parent: - href: 'https://cloud.acquia.com/api/options' + href: https://cloud.acquia.com/api/options limit: - href: 'https://cloud.acquia.com/api/options/colors{?limit}' + href: https://cloud.acquia.com/api/options/colors{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/options/colors{?offset}' + href: https://cloud.acquia.com/api/options/colors{?offset} templated: true sort: - href: 'https://cloud.acquia.com/api/options/colors{?sort}' + href: https://cloud.acquia.com/api/options/colors{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/options/colors{?filter}' + href: https://cloud.acquia.com/api/options/colors{?filter} templated: true _embedded: items: @@ -22415,33 +23495,33 @@ paths: permissions to access the applications within each subscription in the organization. Results can be filtered and sorted by name. operationId: getOrganizations - x-cli-name: 'organizations:list' + x-cli-name: organizations:list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Organizations' + $ref: "#/components/schemas/Organizations" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/organizations' + href: https://cloud.acquia.com/api/organizations sort: - href: 'https://cloud.acquia.com/api/organizations{?sort}' + href: https://cloud.acquia.com/api/organizations{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/organizations{?filter}' + href: https://cloud.acquia.com/api/organizations{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/organizations{?limit}' + href: https://cloud.acquia.com/api/organizations{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/' + href: https://cloud.acquia.com/api/ _embedded: items: - - id: '6' + - id: "6" uuid: bfafd31a-83a6-4257-b0ec-afdeff83117a name: Sample organization subscriptions_total: 115 @@ -22453,15 +23533,15 @@ paths: uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd first_name: First last_name: Last - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name mail: user.name@example.com flags: federated_authentication: false _links: self: - href: 'https://cloud.acquia.com/api/organizations/bfafd31a-83a6-4257-b0ec-afdeff83117a' - - id: '4841' + href: https://cloud.acquia.com/api/organizations/bfafd31a-83a6-4257-b0ec-afdeff83117a + - id: "4841" uuid: 1992bfe6-c5bf-4a90-810e-a65acab42c6e name: Sample organization 2 subscriptions_total: 4 @@ -22473,15 +23553,15 @@ paths: uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd first_name: First last_name: Last - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name mail: user.name@example.com flags: federated_authentication: true _links: self: - href: 'https://cloud.acquia.com/api/organizations/1992bfe6-c5bf-4a90-810e-a65acab42c6e' - - id: '4841' + href: https://cloud.acquia.com/api/organizations/1992bfe6-c5bf-4a90-810e-a65acab42c6e + - id: "4841" uuid: 3ff5a541-64cf-4334-acc7-af70b4374373 name: Sample organization 3 subscriptions_total: 4 @@ -22493,107 +23573,35 @@ paths: uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd first_name: First last_name: Last - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name mail: user.name@example.com flags: federated_authentication: false _links: self: - href: 'https://cloud.acquia.com/api/organizations/3ff5a541-64cf-4334-acc7-af70b4374373' - post: - tags: - - Organizations - summary: Creates a new organization. - description: Creates a new organization. - operationId: postOrganizationsCreate - x-cli-name: 'organizations:create' - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - name - properties: - name: - type: string - description: The name of the organization. - minLength: 1 - maxLength: 255 - example: - name: My new organization - application/x-www-form-urlencoded: - schema: - type: object - required: - - name - properties: - name: - type: string - description: The name of the organization. - minLength: 1 - maxLength: 255 - example: - name: My new organization - security: - - OAuth2: [] - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Message' - examples: - Organization created: - value: - message: Organization created. - '400': - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - examples: - Does not belong to environment: - value: - error: validation_error - message: - name: An organization named New organization already exists. - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - examples: - No user: - value: - error: not_found - message: The user with UUID 3c6a3d3e-c3ee-4fee-97d6-9074971feb76 does not exist. - '/organizations/{organizationUuid}': + href: https://cloud.acquia.com/api/organizations/3ff5a541-64cf-4334-acc7-af70b4374373 + "/organizations/{organizationUuid}": get: tags: - Organizations summary: Return details about a specific organization. operationId: getOrganizationByUuid - x-cli-name: 'organizations:find' + x-cli-name: organizations:find security: - OAuth2: [] description: A specific organization. parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" example: - id: '6' + id: "6" uuid: a81c08c6-a02f-4b57-87e3-c3f395a2bb34 name: Sample organization subscriptions_total: 115 @@ -22605,67 +23613,67 @@ paths: uuid: 98d56f28-cff0-421d-9985-58f15cbd6907 first_name: First last_name: Last - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name mail: user.name@example.com flags: federated_authentication: false _links: self: - href: 'https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34' + href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34 admin-invites: - href: 'https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/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' + 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' + 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' + 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' + href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/members roles: - href: 'https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/roles' + href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/roles subscriptions: - 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' + 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' + href: https://cloud.acquia.com/api/organizations/a81c08c6-a02f-4b57-87e3-c3f395a2bb34/teams parent: - href: 'https://cloud.acquia.com/api/organizations' + href: https://cloud.acquia.com/api/organizations _embedded: owner: uuid: 98d56f28-cff0-421d-9985-58f15cbd6907 first_name: First last_name: Last - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name mail: user.name@example.com _links: self: - href: 'https://cloud.acquia.com/api/users/98d56f28-cff0-421d-9985-58f15cbd6907' - '404': + href: https://cloud.acquia.com/api/users/98d56f28-cff0-421d-9985-58f15cbd6907 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" example: error: not_found - message: 'The organization you are trying to access does not exist, or you do not have permission to access it.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. put: tags: - Organizations summary: Renames an organization. description: Renames an organization. operationId: putOrganization - x-cli-name: 'organizations:update' + x-cli-name: organizations:update parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -22694,113 +23702,113 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Organization renamed: value: message: Organization renamed. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Name unavailable: value: error: conflict message: name: The organization owner already has an organization with this name. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Organizations summary: Deletes a specific organization by its UUID. description: Deletes a specific organization. operationId: deleteOrganization - x-cli-name: 'organizations:delete' + x-cli-name: organizations:delete parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Deleted organization: value: message: Deleted organization. - '400': + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Associated subscriptions: value: error: validation_error message: general: This organization has associated subscriptions and cannot be deleted. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No Permission: value: error: forbidden message: You do not have permission to delete this organization. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: 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.' + message: The organization you are trying to delete does not exist, or you do not have permission to delete it. Not Found: value: error: not_found message: The organization with UUID bfafd31a-83a6-4257-b0ec-afdeff83117a does not exist. - '/organizations/{organizationUuid}/actions/change-owner': + "/organizations/{organizationUuid}/actions/change-owner": post: tags: - Organizations summary: Changes the organization owner. description: Changes the organization owner. operationId: postChangeOrganizationOwner - x-cli-name: 'organizations:owner-change' + x-cli-name: organizations:owner-change parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -22823,38 +23831,38 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Changed owner: value: message: Changed organization owner. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to change the organization owner. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. No organization: value: error: not_found @@ -22863,51 +23871,51 @@ paths: value: error: not_found message: The user with UUID 3ba405e6-8621-4557-b78a-7d92baa79783 does not exist. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: New owner must be administrator: value: error: conflict message: The new owner must be an existing administrator of the organization. - '/organizations/{organizationUuid}/actions/leave': + "/organizations/{organizationUuid}/actions/leave": post: tags: - Organizations summary: Removes your account from an organization. description: Removes your account from an organization. operationId: postLeaveOrganization - x-cli-name: 'organizations:leave' + x-cli-name: organizations:leave parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Left organization: value: message: Left organization. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. No organization: value: error: not_found @@ -22920,18 +23928,18 @@ paths: value: error: not_found message: The user with UUID 3ba405e6-8621-4557-b78a-7d92baa79783 does not exist. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Organization owner cannot be removed: value: error: conflict message: The organization owner cannot be removed. - '/organizations/{organizationUuid}/admins': + "/organizations/{organizationUuid}/admins": get: tags: - Organizations @@ -22951,29 +23959,29 @@ paths: * `mail` * `username` operationId: getOrganizationAdmins - x-cli-name: 'organizations:admin-list' + x-cli-name: organizations:admin-list parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/OrganizationAdminUserProfiles' + $ref: "#/components/schemas/OrganizationAdminUserProfiles" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins' + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins parent: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a' + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a _embedded: items: - uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 @@ -22981,139 +23989,139 @@ paths: last_name: Kirk last_login_at: '2017-03-28T13:07:54-0500' mail: james.kirk@example.com - picture_url: 'https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar' + picture_url: https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar username: james.kirk flags: owner: true _links: self: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3' + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 - uuid: 30dacb5e-4122-11e1-9eb5-12313928d3c2 first_name: Christopher last_name: Pike - last_login_at: '2016-03-28T13:07:54-0500' + last_login_at: 2016-03-28T13:07:54-0500 mail: chris.pike@example.com - picture_url: 'https://accounts.acquia.com/images/users/30dacb5e-4122-11e1-9eb5-12313928d3c2/style/avatar' + picture_url: https://accounts.acquia.com/images/users/30dacb5e-4122-11e1-9eb5-12313928d3c2/style/avatar username: chris.pike flags: owner: false _links: self: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/30dacb5e-4122-11e1-9eb5-12313928d3c2' + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/30dacb5e-4122-11e1-9eb5-12313928d3c2 - uuid: 3bcddc3a-52ba-4cce-aaa3-9adf721c1b52 first_name: Jonathan last_name: Archer last_login_at: null mail: jonathan.archer@example.com - picture_url: 'https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar' + picture_url: https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar username: jonathan.archer flags: owner: false _links: self: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52' - '404': + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admins/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/admins/{userUuid}': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/admins/{userUuid}": get: tags: - Organizations summary: Returns the user profile of this organization administrator. description: Returns the user profile of this organization administrator. operationId: getOrganizationAdmin - x-cli-name: 'organizations:admin-find' + x-cli-name: organizations:admin-find parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/UserUuid' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/UserUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/OrganizationAdminUserProfile' + $ref: "#/components/schemas/OrganizationAdminUserProfile" example: uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 first_name: James last_name: Kirk last_login_at: '2017-03-28T13:07:54-0500' mail: james.kirk@example.com - picture_url: 'https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar' + picture_url: https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar username: james.kirk flags: owner: true _links: self: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/admins/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/admins/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 parent: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/admins' - '403': + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/admins + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to view this administrator. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Organizations summary: Removes the user from the list of administrators for the organization. description: Removes the user from the list of administrators for the organization. operationId: deleteOrganizationAdmin - x-cli-name: 'organizations:admin-delete' + x-cli-name: organizations:admin-delete security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/UserUuid' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/UserUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Member removed: value: message: Organization administrator removed. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + 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 @@ -23126,7 +24134,7 @@ paths: value: error: not_found message: The user with UUID 5404f30f-465c-4d94-80f1-61f1d35fde0b does not exist. - '/organizations/{organizationUuid}/admin-invites': + "/organizations/{organizationUuid}/admin-invites": get: tags: - Organizations @@ -23144,30 +24152,30 @@ paths: * `last_name` * `permission` operationId: getOrganizationAdminInvites - x-cli-name: 'organizations:admin-invite-list' - parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Range' + x-cli-name: organizations:admin-invite-list + parameters: + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Range" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/OrganizationAdminInvites' + $ref: "#/components/schemas/OrganizationAdminInvites" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admin-invites' + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/admin-invites parent: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a' + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a _embedded: items: - author: @@ -23176,7 +24184,7 @@ paths: 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' + picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com organization: name: Organization Name uuid: a45a99ce-e1ae-47ac-a570-8189bc4d3347 @@ -23188,7 +24196,7 @@ paths: declined: false _links: self: - href: 'https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ec' + href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ec - organization: name: Organization Name uuid: a45a99ce-e1ae-47ac-a570-8189bc4d3347 @@ -23198,7 +24206,7 @@ paths: 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' + picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=john.doe@example.com uuid: 857a8ec9-ac33-428d-8b1c-718d7f6f9aa4 email: invitee2@example.com created_at: '2012-05-15T12:00:00Z' @@ -23207,31 +24215,31 @@ paths: declined: false _links: self: - href: 'https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed' - '404': + href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. post: tags: - Organizations summary: Invites a user to be an administrator in this organization. description: Invites a user to be an administrator in this organization. operationId: postOrganizationAdminInvite - x-cli-name: 'organizations:admin-invite-create' + x-cli-name: organizations:admin-invite-create parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -23260,39 +24268,39 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Role created: value: message: Invited organization administrator. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '409': + message: The organization you are trying to retrieve does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/applications': + message: An invitation to test@example.com has already been sent. It was sent on May 6, 2016 - 7:26pm. + "/organizations/{organizationUuid}/applications": get: tags: - Organizations @@ -23308,22 +24316,22 @@ paths: * `name` * `organization_name` operationId: getOrganizationApplications - x-cli-name: 'organizations:applications-list' + x-cli-name: organizations:applications-list parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/OrganizationApplications' + $ref: "#/components/schemas/OrganizationApplications" example: total: 2 pagination: @@ -23332,21 +24340,21 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications' + 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}' + href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/applications{?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}' + 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}' + 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' + href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481 _embedded: items: - id: 241643 @@ -23354,7 +24362,7 @@ paths: name: Sample application 1 hosting: type: acp - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6 name: Sample subscription @@ -23364,30 +24372,31 @@ paths: flags: remote_admin: true status: normal + type: drupal _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 tags: - name: tag-1 color: blue _links: self: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1 + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1 parent: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - name: tag-2 color: green _links: self: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2 + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2 parent: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - id: 954291 uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471 name: Sample application 2 hosting: type: free - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6 name: Sample subscription @@ -23397,54 +24406,55 @@ paths: flags: remote_admin: false status: provisioning + type: drupal _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471 tags: - name: tag-1 color: blue _links: self: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1 + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-1 parent: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - name: tag-2 color: green _links: self: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2 + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags/tag-2 parent: - href: /api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags - '404': + href: https://cloud.acquia.com/api/applications/957bec0e-30c1-4971-ae2a-2ec4071cdd4e/tags + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/available-tags': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/available-tags": get: tags: - Organizations summary: Returns a list of all available application tags. description: Returns a list of all available application tags. operationId: getOrganizationAvailableTags - x-cli-name: 'organizations:available-tags-list' + x-cli-name: organizations:available-tags-list parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/OrganizationAvailableTags' + $ref: "#/components/schemas/OrganizationAvailableTags" example: total: 1 pagination: @@ -23453,20 +24463,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags parent: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c limit: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags{?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}' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags{?offset} templated: true sort: - 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 filter: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags{?filter}' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/available-tags{?filter} templated: true _embedded: items: @@ -23479,30 +24489,30 @@ paths: application: uuids: - 185f07c7-9c4f-407b-8968-67892ebcb38a - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. post: tags: - Organizations summary: Adds bulk tags to organization resources. description: Adds bulk tags to organization resources. operationId: postOrganizationAvailableTags - x-cli-name: 'organizations:available-tags-create' + x-cli-name: organizations:available-tags-create parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -23617,56 +24627,56 @@ paths: security: - OAuth2: [] responses: - '201': + "201": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Tags have been updated. _links: self: - href: 'https://cloud.acquia.com/api/organizations/87c7be4d-d65d-4a5c-b36b-d921ca86c590/available-tags' + href: https://cloud.acquia.com/api/organizations/87c7be4d-d65d-4a5c-b36b-d921ca86c590/available-tags notification: - href: 'https://cloud.acquia.com/api/notifications/6992a41d-a953-4ded-ae99-41d2f4d62f69' + 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' - '403': + href: https://cloud.acquia.com/api/organizations/87c7be4d-d65d-4a5c-b36b-d921ca86c590 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Forbidden: value: error: forbidden message: You do not have permission to add tags to one or more of the specified resources. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Organizations summary: Deletes bulk tags from organization resources. description: Deletes bulk tags from organization resources. operationId: deleteOrganizationAvailableTags - x-cli-name: 'organizations:available-tags-delete' + x-cli-name: organizations:available-tags-delete parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -23769,89 +24779,89 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Tags have been updated. _links: self: - href: 'https://cloud.acquia.com/api/organizations/1be8dcdf-e4fd-4a89-9d64-9e4486272c7a/available-tags' + href: https://cloud.acquia.com/api/organizations/1be8dcdf-e4fd-4a89-9d64-9e4486272c7a/available-tags parent: - href: 'https://cloud.acquia.com/api/organizations/1be8dcdf-e4fd-4a89-9d64-9e4486272c7a' + href: https://cloud.acquia.com/api/organizations/1be8dcdf-e4fd-4a89-9d64-9e4486272c7a notification: - href: 'https://cloud.acquia.com/api/notifications/154f88be-b9c0-47c4-b0cb-83eb6aebb7b7' - '403': + href: https://cloud.acquia.com/api/notifications/154f88be-b9c0-47c4-b0cb-83eb6aebb7b7 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Forbidden: value: error: forbidden message: You do not have permission to remove tags from one or more of the specified resources. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/identity-provider': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/identity-provider": get: tags: - Organizations summary: Returns an identity provider for an organization. description: Returns an identity provider for an organization. operationId: getOrganizationIdentityProvider - x-cli-name: 'organizations:identity-provider-find' + x-cli-name: organizations:identity-provider-find parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/IdentityProvider' + $ref: "#/components/schemas/IdentityProvider" example: uuid: 1bc5dbb4-6d59-403b-afc7-777e520aaa40 label: Test identity provider - idp_entity_id: 'https://idp.example.com/saml' - sp_entity_id: 'https://sp.example.com/saml' - sso_url: 'https://example.com/sso' - certificate: '-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----' + idp_entity_id: https://idp.example.com/saml + sp_entity_id: https://sp.example.com/saml + sso_url: https://example.com/sso + certificate: -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- status: enabled _links: self: - href: 'https://cloud.acquia.com/api/identity-providers/1bc5dbb4-6d59-403b-afc7-777e520aaa40' + href: https://cloud.acquia.com/api/identity-providers/1bc5dbb4-6d59-403b-afc7-777e520aaa40 parent: - href: 'https://cloud.acquia.com/api/identity-providers' + href: https://cloud.acquia.com/api/identity-providers acs: - href: 'https://accounts.acquia.com/api/auth/saml/acs/1bc5dbb4-6d59-403b-afc7-777e520aaa40' - '404': + href: https://accounts.acquia.com/api/auth/saml/acs/1bc5dbb4-6d59-403b-afc7-777e520aaa40 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/members': + message: The identity provider you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/members": get: tags: - Organizations @@ -23869,37 +24879,37 @@ paths: * `last_name` * `permission` operationId: getOrganizationMembers - x-cli-name: 'organizations:members-list' + x-cli-name: organizations:members-list parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/OrganizationMembers' + $ref: "#/components/schemas/OrganizationMembers" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/members' + 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}' + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/members{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a/members{?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}' + 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' + href: https://cloud.acquia.com/api/organizations/3c9ea553-3216-11e3-9170-12313920a23a _embedded: items: - uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 @@ -23907,7 +24917,7 @@ paths: last_name: Kirk last_login_at: '2017-03-28T13:07:54-0500' mail: james.kirk@example.com - picture_url: 'https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar' + picture_url: https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar username: james.kirk teams: - name: Team Name 1 @@ -23917,13 +24927,13 @@ paths: name: Senior Developer _links: self: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 - uuid: 30dacb5e-4122-11e1-9eb5-12313928d3c2 first_name: Christopher last_name: Pike mail: chris.pike@example.com last_login_at: '2018-02-19T13:07:54-0500' - picture_url: 'https://accounts.acquia.com/images/users/30dacb5e-4122-11e1-9eb5-12313928d3c2/style/avatar' + picture_url: https://accounts.acquia.com/images/users/30dacb5e-4122-11e1-9eb5-12313928d3c2/style/avatar username: chris.pike teams: - name: Team Name 2 @@ -23933,13 +24943,13 @@ paths: name: Developer _links: self: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/30dacb5e-4122-11e1-9eb5-12313928d3c2' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/30dacb5e-4122-11e1-9eb5-12313928d3c2 - uuid: 3bcddc3a-52ba-4cce-aaa3-9adf721c1b52 first_name: Jonathan last_name: Archer last_login_at: null mail: jonathan.archer@example.com - picture_url: 'https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar' + picture_url: https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar username: jonathan.archer teams: - name: Team Name 1 @@ -23954,45 +24964,45 @@ paths: name: Developer _links: self: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52' - '404': + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/members/{userUuid}': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/members/{userUuid}": get: tags: - Organizations description: Returns the user profile of this organization member. summary: Returns the user profile of this organization member. operationId: getOrganizationMember - x-cli-name: 'organizations:member-find' + x-cli-name: organizations:member-find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/UserUuid' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/UserUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/OrganizationUserProfile' + $ref: "#/components/schemas/OrganizationUserProfile" example: uuid: 3bcddc3a-52ba-4cce-aaa3-9adf721c1b52 first_name: Jonathan last_name: Archer last_login_at: '2017-03-28T13:07:54-0500' mail: jonathan.archer@example.com - picture_url: 'https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar' + picture_url: https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar username: jonathan.archer teams: - name: Team Name 1 @@ -24007,67 +25017,67 @@ paths: name: Developer _links: self: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52 parent: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members' + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members applications: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/applications' - '403': + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c/members/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/applications + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: forbidden message: You do not have permission to view this member. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Organizations summary: Removes the member from the organization. description: Removes the member from the organization. operationId: postOrganizationMemberDelete - x-cli-name: 'organizations:member-delete' + x-cli-name: organizations:member-delete security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/UserUuid' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/UserUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Member removed: value: message: Organization member removed. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + 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 @@ -24080,53 +25090,53 @@ paths: value: error: not_found message: The user is not a member of this organization. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application mismatch: value: error: conflict message: The organization owner cannot be removed. - '/organizations/{organizationUuid}/members/{userUuid}/applications': + "/organizations/{organizationUuid}/members/{userUuid}/applications": get: tags: - Organizations summary: Returns a list of applications that an organization member has access to. description: Returns a list of applications that an organization member has access to. operationId: getOrganizationMemberApplications - x-cli-name: 'organizations:member-application-list' + x-cli-name: organizations:member-application-list parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/UserUuid' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/UserUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Applications' + $ref: "#/components/schemas/Applications" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de/applications' + 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}' + href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de/applications{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de/applications{?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}' + 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' + href: https://cloud.acquia.com/api/organizations/d4e44648-8780-4105-905c-43a1eb486481/members/48b8085f-defd-423b-96ca-0f634bcf07de _embedded: items: - id: 241643 @@ -24134,7 +25144,7 @@ paths: name: Sample application 1 hosting: type: acp - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6 name: Sample subscription @@ -24144,15 +25154,16 @@ paths: flags: remote_admin: true status: normal + type: drupal _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 - id: 954291 uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471 name: Sample application 2 hosting: type: free - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: be3a7975-d62b-4e29-b24f-dfb2a43468e6 name: Sample subscription @@ -24162,32 +25173,33 @@ paths: flags: remote_admin: false status: provisioning + type: drupal _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471' - '403': + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found or no permission: value: error: forbidden message: You do not have permission to view the applications this member has access to. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/notifications': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/notifications": get: tags: - Organizations @@ -24213,20 +25225,20 @@ paths: * `created_at` * `completed_at` operationId: getOrganizationNotifications - x-cli-name: 'organizations:notification-list' + x-cli-name: organizations:notification-list parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: organization/json: schema: - $ref: '#/components/schemas/OrganizationsNotifications' + $ref: "#/components/schemas/OrganizationsNotifications" example: total: 1 pagination: @@ -24235,20 +25247,20 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications' + href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications parent: - href: 'https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d' + href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d limit: - href: 'https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications{?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}' + href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications{?offset} templated: true sort: - 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 filter: - href: 'https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications{?filter}' + href: https://cloud.acquia.com/api/organizations/2be7b4e8-6e9b-4314-8ad5-6a0b3f54c38d/notifications{?filter} templated: true _embedded: items: @@ -24284,9 +25296,9 @@ paths: - 1dd0f44b-6118-4c95-a3a2-a9deea32b2b0 _links: self: - href: 'https://cloud.acquia.com/api/notifications/5c5e848b-296a-4c64-94aa-5a97d99da189' + href: https://cloud.acquia.com/api/notifications/5c5e848b-296a-4c64-94aa-5a97d99da189 parent: - href: 'https://cloud.acquia.com/api/notifications' + href: https://cloud.acquia.com/api/notifications _embedded: author: uuid: 08a44409-568f-46f6-8038-4f30e19e3eb2 @@ -24295,20 +25307,20 @@ paths: last_login_at: '2022-11-30T16:22:48+00:00' created_at: '2019-10-15T20:22:19+00:00' email: thomas.a.anderson@acquia.com - picture_url: 'https://accounts.acquia.com/images/users/08a44409-568f-46f6-8038-4f30e19e3eb2/style/avatar' + picture_url: https://accounts.acquia.com/images/users/08a44409-568f-46f6-8038-4f30e19e3eb2/style/avatar username: thomas.a.anderson@acquia.com - '404': + "404": description: Not Found content: organization/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/roles': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/roles": get: tags: - Organizations @@ -24324,39 +25336,39 @@ paths: * `name` * `edited_at` operationId: getOrganizationRoles - x-cli-name: 'organizations:roles-list' - parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Range' + x-cli-name: organizations:roles-list + parameters: + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Range" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Roles' + $ref: "#/components/schemas/Roles" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles' + 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}' + href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baedc/roles{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baedc/roles{?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}' + 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' + href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede _embedded: items: - uuid: 312c0121-906b-4498-8402-7b479172768c @@ -24367,23 +25379,25 @@ paths: label: Add or remove a user of a team description: Granting this permission will give any user with this role full permissions on this team. group_label: Administration + flags: + deprecated: false organization: uuid: 065f4d9e-efbf-4b0e-8cf6-42fa432baede name: Example Organization last_edited: - edited_at: '2011-03-28T13:09:41-04:00' + edited_at: 2011-03-28T13:09:41-04:00 user: uuid: aaaa1234-11e2-c374-6954-6931d150b259 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' + picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com username: jane.doe flags: default: true _links: self: - href: 'https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/312c0121-906b-4498-8402-7b479172768c' + href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/312c0121-906b-4498-8402-7b479172768c - uuid: 5f7da0a9-9ff0-4db8-802e-9d2b9969efc2 name: Senior Developer description: Some details about senior developer. @@ -24392,27 +25406,31 @@ paths: label: Access the Cloud API description: Grants the ability to use the API and bypass all other permissions via command line tools. group_label: Administration + flags: + deprecated: false - name: administer team label: Add or remove a user of a team description: Granting this permission will give any user with this role full permissions on this team. group_label: Administration + flags: + deprecated: false organization: uuid: 065f4d9e-efbf-4b0e-8cf6-42fa432baede name: Example Organization last_edited: - edited_at: '2011-03-28T13:09:41-04:00' + edited_at: 2011-03-28T13:09:41-04:00 user: - uuid: null + uuid: 6661357e-f562-4b77-8de9-60b4bf83e01b first_name: Acquia last_name: Support mail: support@acquia.com picture_url: null - username: null + username: support.acquia flags: default: false _links: self: - href: 'https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/5f7da0a9-9ff0-4db8-802e-9d2b9969efc2' + href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/5f7da0a9-9ff0-4db8-802e-9d2b9969efc2 - uuid: d33cd9ff-281d-4bcf-9f89-b10b249caa35 name: Developer description: Some details about developer. @@ -24421,47 +25439,49 @@ paths: label: Access the Cloud API description: Grants the ability to use the API and bypass all other permissions via command line tools. group_label: Administration + flags: + deprecated: false organization: uuid: 065f4d9e-efbf-4b0e-8cf6-42fa432baede name: Example Organization last_edited: - edited_at: '2011-03-28T13:09:41-04:00' + edited_at: 2011-03-28T13:09:41-04:00 user: uuid: bbbb1234-11e2-c374-6954-6931d150b259 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' + picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=john.doe@example.com username: john.doe flags: default: false _links: self: - href: 'https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/5f7da0a9-9ff0-4db8-802e-9d2b9969efc2' - '404': + href: https://cloud.acquia.com/api/organizations/065f4d9e-efbf-4b0e-8cf6-42fa432baede/roles/5f7da0a9-9ff0-4db8-802e-9d2b9969efc2 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. post: tags: - Organizations summary: Creates a role. description: Creates a role. operationId: postOrganizationRoles - x-cli-name: 'organizations:role-create' + x-cli-name: organizations:role-create parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -24522,45 +25542,45 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Role created: value: message: Role created. - '400': + "400": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Invalid permission: value: error: validation_failed message: permissions: The permission 'permission 1' is not a valid permission - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '409': + message: The organization you are trying to retrieve does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Role already exists: value: @@ -24570,7 +25590,7 @@ paths: value: error: conflict message: An organization must have at least one team in order to create new roles. - '/organizations/{organizationUuid}/subscriptions': + "/organizations/{organizationUuid}/subscriptions": get: tags: - Organizations @@ -24584,37 +25604,37 @@ paths: Sortable fields: * `name` operationId: getOrganizationSubscriptions - x-cli-name: 'organizations:subscriptions-list' - parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Range' + x-cli-name: organizations:subscriptions-list + parameters: + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Range" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Applications' + $ref: "#/components/schemas/Applications" example: - $ref: '#/paths/~1organizations~1%7BorganizationUuid%7D~1applications/get/responses/200/content/application~1json/example' - '404': + $ref: "#/paths/~1organizations~1%7BorganizationUuid%7D~1applications/get/responses/200/content/application~1hal%2Bjson/example" + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/team-invites': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/team-invites": get: tags: - Organizations @@ -24628,49 +25648,49 @@ paths: Sortable fields: * `name` operationId: getOrganizationTeamInvites - x-cli-name: 'organizations:team-invite-list' + x-cli-name: organizations:team-invite-list parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/OrganizationTeamInvites' + $ref: "#/components/schemas/OrganizationTeamInvites" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96/team-invites' + 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}' + href: https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96/team-invites{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96/team-invites{?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}' + 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' + href: https://cloud.acquia.com/api/organizations/d72c0cf8-62e2-418d-8530-6e54f122cf96 _embedded: items: - - applications: null + - applications: [] author: uuid: 879fc134-e8d9-49ab-a1a8-ffa33fddf8c9 first_name: Joe last_name: Smith last_login_at: '2019-01-30T08:58:07-05:00' - created_at: '2014-08-14T17:37:23-04:00' + created_at: 2014-08-14T17:37:23-04:00 mail: joe.smith@example.com - picture_url: 'https://accounts.acquia.com/images/users/879fc134-e8d9-49ab-a1a8-ffa33fddf8c9/style/avatar' + picture_url: https://accounts.acquia.com/images/users/879fc134-e8d9-49ab-a1a8-ffa33fddf8c9/style/avatar username: joe.smith organization: uuid: d72c0cf8-62e2-418d-8530-6e54f122cf96 @@ -24689,8 +25709,8 @@ paths: declined: true _links: self: - href: 'https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ec' - - applications: null + href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ec + - applications: [] author: uuid: 7e181890-bfb9-40d7-874b-ec78912c7525 first_name: Jane @@ -24698,7 +25718,7 @@ paths: last_login_at: '2018-01-30T08:58:07-05:00' created_at: '2017-08-14T17:37:23-04:00' mail: jane.smith@example.com - picture_url: 'https://accounts.acquia.com/images/users/7e181890-bfb9-40d7-874b-ec78912c7525/style/avatar' + picture_url: https://accounts.acquia.com/images/users/7e181890-bfb9-40d7-874b-ec78912c7525/style/avatar username: joe.smith organization: uuid: d72c0cf8-62e2-418d-8530-6e54f122cf96 @@ -24719,8 +25739,8 @@ paths: declined: false _links: self: - href: 'https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed' - - applications: null + href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed + - applications: [] author: uuid: 36dd8434-8eda-4c75-9f80-4f8a76d622b2 first_name: David @@ -24728,7 +25748,7 @@ paths: last_login_at: '2018-03-21T08:48:07-05:00' created_at: '2016-03-14T17:37:23-04:00' mail: david.green@example.com - picture_url: 'https://accounts.acquia.com/images/users/36dd8434-8eda-4c75-9f80-4f8a76d622b2/style/avatar' + picture_url: https://accounts.acquia.com/images/users/36dd8434-8eda-4c75-9f80-4f8a76d622b2/style/avatar username: joe.smith organization: uuid: d72c0cf8-62e2-418d-8530-6e54f122cf96 @@ -24747,19 +25767,19 @@ paths: declined: false _links: self: - href: 'https://cloud.acquia.com/api/invites/aa1ea69fdcb6bee08b31a858b85535ee' - '404': + href: https://cloud.acquia.com/api/invites/aa1ea69fdcb6bee08b31a858b85535ee + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '/organizations/{organizationUuid}/teams': + message: The organization you are trying to access does not exist, or you do not have permission to access it. + "/organizations/{organizationUuid}/teams": get: tags: - Organizations @@ -24773,38 +25793,38 @@ paths: Sortable fields: * `name` operationId: getOrganizationTeams - x-cli-name: 'organizations:team-list' + x-cli-name: organizations:team-list parameters: - - $ref: '#/components/parameters/OrganizationUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/OrganizationUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Teams' + $ref: "#/components/schemas/Teams" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc/teams' + 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}' + href: https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc/teams{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc/teams{?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}' + 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' + href: https://cloud.acquia.com/api/organizations/3856ef7d-5c9a-49e2-8fff-649e9a81a3bc _embedded: items: - uuid: e8a29774-8f46-4765-9529-d564c81ba05f @@ -24816,7 +25836,7 @@ paths: name: Sample Organization _links: self: - href: 'https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c' + href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c - uuid: 4b30d7e6-84af-4d80-931a-4172f57fe1b0 name: Team Name 2 created_at: '2014-05-27T11:55:39-0700' @@ -24826,31 +25846,31 @@ paths: name: Sample Organization _links: self: - href: 'https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f' - '404': + href: https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' + message: The organization you are trying to access does not exist, or you do not have permission to access it. post: tags: - Organizations summary: Creates a team. description: Creates a team. operationId: postOrganizationTeams - x-cli-name: 'organizations:team-create' + x-cli-name: organizations:team-create parameters: - - $ref: '#/components/parameters/OrganizationUuid' + - $ref: "#/components/parameters/OrganizationUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -24879,39 +25899,39 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Invited: value: message: Team created. - '201': + "201": description: Created content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Team' - '404': + $ref: "#/components/schemas/Team" + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" 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.' - '409': + message: The organization you are trying to retrieve does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Team name already exists: value: @@ -24926,29 +25946,29 @@ paths: Displays a list of all available permissions currently in the system. This will include permissions that the user may not have access to. operationId: getPermissions - x-cli-name: 'permissions:list' + x-cli-name: permissions:list responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Permissions' + $ref: "#/components/schemas/Permissions" example: total: 49 _links: self: - href: 'https://cloud.acquia.com/api/permissions' + href: https://cloud.acquia.com/api/permissions _embedded: items: - name: deploy to non-prod - label: 'Pull and deploy code, files, or databases to non-production environments' + label: Pull and deploy code, files, or databases to non-production environments description: Grants the ability to enable or disable live development and non-production work. group_label: Workflow flags: deprecated: false - name: deploy to prod - label: 'Deploy code, files, or databases to the production environment' + label: Deploy code, files, or databases to the production environment description: null group_label: Workflow flags: @@ -25092,7 +26112,7 @@ paths: flags: deprecated: false - name: view database connection - label: 'View database connection details (username, password, or hostname)' + label: View database connection details (username, password, or hostname) description: null group_label: Databases flags: @@ -25169,12 +26189,6 @@ paths: group_label: Support flags: deprecated: false - - name: administer ssh keys - label: Manage SSH keys - description: Grants the ability to use SSH and bypass all other permissions via command line tools. - group_label: SSH keys - flags: - deprecated: false - name: view build plans label: View Build plans description: null @@ -25235,7 +26249,7 @@ paths: group_label: Workflow flags: deprecated: false - '/roles/{roleUuid}': + "/roles/{roleUuid}": get: tags: - Teams and Permissions @@ -25244,110 +26258,118 @@ paths: Roles may be assigned to team members, and grant various permissions to the applications that the team is assigned to. Roles are unique within a organization. operationId: getRole - x-cli-name: 'tps:role-find' + x-cli-name: tps:role-find parameters: - - $ref: '#/components/parameters/RoleUuid' + - $ref: "#/components/parameters/RoleUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Role' + $ref: "#/components/schemas/Role" example: uuid: c885728d-cbbe-4e54-bf09-19b751b6d0c7 name: My Custom Role description: Some details about my custom role. permissions: - name: deploy to non-prod - label: 'Pull and deploy code, files, or databases to non-production environments' + label: Pull and deploy code, files, or databases to non-production environments description: Grants the ability to enable or disable live development and non-production work. group_label: Workflow + flags: + deprecated: false - name: configure non-prod env label: Configure non-production environments description: null group_label: Workflow + flags: + deprecated: false - name: download logs non-prod label: Download logs for non-production environments description: null group_label: Logs + flags: + deprecated: false - name: view database connection - label: 'View database connection details (username, password, or hostname)' + label: View database connection details (username, password, or hostname) description: null group_label: Databases + flags: + deprecated: false organization: uuid: d122cc06-35bd-41bf-9baa-5b770c8ca0f1 name: My Organization last_edited: - edited_at: '2011-03-28T13:09:41-04:00' + edited_at: 2011-03-28T13:09:41-04:00 user: uuid: 590909a0-e819-43e6-a8e3-212dc3e35852 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' + picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com username: jane.doe flags: default: false - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Role not found: value: error: not_found - message: 'The role you are trying to access does not exist, or you do not have permission to access it.' + message: The role you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Teams and Permissions summary: Deletes a specific role by its UUID. description: Deletes a specific role. operationId: deleteRole - x-cli-name: 'tps:roles-delete' + x-cli-name: tps:roles-delete parameters: - - $ref: '#/components/parameters/RoleUuid' + - $ref: "#/components/parameters/RoleUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" example: message: Deleted role. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Role not found: value: error: not_found - message: 'The role you are trying to delete does not exist, or you do not have permission to delete it.' + message: The role you are trying to delete does not exist, or you do not have permission to delete it. put: tags: - Teams and Permissions summary: Updates a role. operationId: putRoleByUuid - x-cli-name: 'tps:role-update' + x-cli-name: tps:role-update security: - OAuth2: [] description: Modifies a role. parameters: - - $ref: '#/components/parameters/RoleUuid' + - $ref: "#/components/parameters/RoleUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -25400,30 +26422,476 @@ paths: example: name: My new application name responses: - '200': + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Message" + example: + message: Updating role. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Role not found: + value: + error: not_found + message: The role you are trying to access does not exist, or you do not have permission to edit it. + /subscriptions: + get: + tags: + - Subscriptions + summary: Return a list of subscription. + description: | + Filterable fields: + * `from` + * `to` + * `sort` + * `filter` + * `limit` + * `offset` + + Sortable fields: + * `from` + * `to` + * `sort` + * `filter` + * `limit` + * `offset` + operationId: getSubscriptions + x-cli-name: subscriptions:list + parameters: + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Subscriptions" + example: + total: 3 + _links: + self: + href: https://cloud.acquia.com/api/subscriptions + sort: + href: https://cloud.acquia.com/api/subscriptions{?sort} + templated: true + filter: + href: https://cloud.acquia.com/api/subscriptions{?filter} + templated: true + limit: + href: https://cloud.acquia.com/api/subscriptions{?limit} + templated: true + parent: + href: https://cloud.acquia.com/api/ + _embedded: + items: + - id: 123 + uuid: faa297f3-f59a-4abc-8d71-904f51bcb1c5 + name: Acquia Cloud Free Subscription + start_at: 2011-03-28T00:00:00 + expire_at: 2015-11-11T00:00:00 + product: + id: 1890149 + name: Acquia Cloud Free + type: free + applications_total: 3 + applications_used: 1 + organization: + uuid: 39f38840-c494-4622-80a5-fc40269cb42d + name: Acquia Inc. + flags: + active: true + expired: true + zuora: false + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/faa297f3-f59a-4abc-8d71-904f51bcb1c5 + _embedded: + organization: + uuid: 39f38840-c494-4622-80a5-fc40269cb42d + name: Acquia Inc. + _links: + self: + href: https://cloud.acquia.com/api/organizations/39f38840-c494-4622-80a5-fc40269cb42d + parent: + href: https://cloud.acquia.com/api/organizations + - id: 222 + uuid: 36496037-6eb5-482d-8549-e45e1718f2b7 + name: My Acquia Subscription + start_at: '2012-05-15T12:00:00Z' + expire_at: 2015-05-15T12:00:00Z + product: + id: 8999 + name: Enterprise + type: enterprise + applications_total: 5 + applications_used: 2 + organization: + uuid: 93c97126-2870-47f0-9ffd-9a92033c443e + name: My Organization + flags: + active: true + expired: true + zuora: false + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/36496037-6eb5-482d-8549-e45e1718f2b7 + _embedded: + organization: + uuid: 93c97126-2870-47f0-9ffd-9a92033c443e + name: My Organization + _links: + self: + href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e + parent: + href: https://cloud.acquia.com/api/organizations + - id: 333 + uuid: 2d92f652-882c-458a-8183-4d9cef7c2fde + name: My Acquia Subscription 2 + start_at: '2012-05-15T12:00:00Z' + expire_at: 2015-05-15T12:00:00Z + product: + id: 8999 + name: Enterprise + type: enterprise + applications_total: 5 + applications_used: 2 + organization: + uuid: 93c97126-2870-47f0-9ffd-9a92033c443e + name: My Organization + flags: + active: true + expired: true + zuora: false + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/2d92f652-882c-458a-8183-4d9cef7c2fde + _embedded: + organization: + uuid: 93c97126-2870-47f0-9ffd-9a92033c443e + name: My Organization + _links: + self: + href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e + parent: + href: https://cloud.acquia.com/api/organizations + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Not found: + value: + error: not_found + message: You do not have permission to view subscriptions. + "/subscriptions/{subscriptionUuid}": + get: + tags: + - Subscriptions + summary: Return details about a specific subscription. + description: Return details about a specific subscription. + operationId: getSubscription + x-cli-name: subscriptions:find + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/SubscriptionUuid" + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Subscription" + example: + id: 329876 + uuid: 8533debb-ae4e-427b-aa34-731719b4201a + name: My Subscription + start_at: 2015-05-13T00:00:00 + expire_at: 2018-05-12T00:00:00 + product: + id: 8999 + name: Enterprise + type: enterprise + applications_total: 10 + applications_used: 0 + organization: + uuid: 93c97126-2870-47f0-9ffd-9a92033c443e + name: My Organization + flags: + active: true + expired: true + zuora: false + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a + applications: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications + entitlements: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/entitlements + ides: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/ides + shield-acl: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/shield-acl + parent: + href: https://cloud.acquia.com/api/subscriptions + _embedded: + organization: + uuid: 93c97126-2870-47f0-9ffd-9a92033c443e + name: My Organization + _links: + self: + href: https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e + parent: + href: https://cloud.acquia.com/api/organizations + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No subscription or permission: + value: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + put: + tags: + - Subscriptions + summary: Modifies a subscription. + description: Modifies a subscription. + operationId: putSubscription + x-cli-name: subscriptions:update + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/SubscriptionUuid" + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + name: + type: string + description: The new subscription name. + maxLength: 255 + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Message" + examples: + Subscription updated: + value: + message: Subscription updated. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Validation failed: + value: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/apm": + get: + tags: + - Application Performance Monitoring Services + summary: Returns a list of Application Performance Monitoring services associated with the subscription. + description: Returns a list of Application Performance Monitoring services associated with the subscription. + operationId: getSubscriptionApmTypes + x-cli-name: subscriptions:apm-list + parameters: + - $ref: "#/components/parameters/SubscriptionUuid" + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/ApmTypes" + example: + total: 1 + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm + parent: + href: https://cloud.acquia.com/api/subscriptions + sort: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm{?sort} + templated: true + filter: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm{?filter} + templated: true + _embedded: + items: + - type: newrelic + flags: + opted-in: true + key: 2d1dfa83d5e1494793957e7ce572942b + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm/newrelic + parent: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + example: + error: forbidden + message: You do not have permission to access APM summaries for this subscription. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + example: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/apm/{apmType}": + get: + tags: + - Application Performance Monitoring Services + summary: Returns the Application Performance Monitoring service type associated with the subscription. + description: Returns the Application Performance Monitoring service type associated with the subscription. + operationId: getSubscriptionApmType + x-cli-name: subscriptions:apm-list + parameters: + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/ApmType" + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/ApmType" + example: + type: newrelic + flags: + opted-in: true + key: 2d1dfa83d5e1494793957e7ce572942b + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a + parent: + href: https://cloud.acquia.com/api/subscriptions + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + example: + error: forbidden + message: You do not have permission to access this APM summary type. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + example: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/apm/{apmType}/actions/opt-in": + post: + tags: + - Application Performance Monitoring Services + summary: Enables New Relic Pro APM license for all applications on a subscription. + description: Enables New Relic Pro APM license for all applications on a subscription. This authorizes Acquia to create a new user account on the third-party New Relic platform using the name and e-mail address of the organization owner. + operationId: postSubscriptionApmOptIn + x-cli-name: subscriptions:apm-opt-in + parameters: + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/ApmType" + security: + - OAuth2: [] + responses: + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' - example: - message: Updating role. - '404': + $ref: "#/components/schemas/MessageWithLinks" + examples: + APM Type Enabled: + value: + message: APM type newrelic has been enabled on the example subscription. + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm/newrelic/actions/opt-in + parent: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm/newrelic/actions + notification: + href: https://cloud.acquia.com/api/notifications/7b37b885-8ae4-454b-b8fa-ffaeff54f6a4 + "400": + description: Bad Request + content: + application/hal+json: + schema: + $ref: "#/components/schemas/ValidationError" + examples: + APM type unavailable: + value: + error: validation_failed + message: + name: New Relic is not available for this subscription. + Must be organization owner: + value: + error: validation_failed + message: + name: Only the organization owner may opt into data sharing. + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + Insufficient permissions: + value: + error: forbidden + message: You do not have permission to opt-in to APM settings for this subscription. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: - Role not found: + Not found: value: error: not_found - message: 'The role you are trying to access does not exist, or you do not have permission to edit it.' - /subscriptions: + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/applications": get: tags: - Subscriptions - summary: Return a list of subscription. + summary: Provides a list of applications that are a part of the subscription. description: | Filterable fields: * `from` @@ -25440,557 +26908,605 @@ paths: * `filter` * `limit` * `offset` - operationId: getSubscriptions - x-cli-name: 'subscriptions:list' + operationId: getSubscriptionApplications + x-cli-name: subscriptions:application-list parameters: - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Subscriptions' + $ref: "#/components/schemas/SubscriptionApplications" example: - total: 3 + total: 2 + pagination: + total: 2 + limit: 10 + offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions' + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications + parent: + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a sort: - href: 'https://cloud.acquia.com/api/subscriptions{?sort}' + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/subscriptions{?filter}' + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/subscriptions{?limit}' + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?limit} templated: true - parent: - href: 'https://cloud.acquia.com/api/' _embedded: items: - - id: 123 - uuid: faa297f3-f59a-4abc-8d71-904f51bcb1c5 - name: Acquia Cloud Free Subscription - start_at: '2011-03-28T00:00:00' - expire_at: '2015-11-11T00:00:00' - product: - id: 1890149 - name: Acquia Cloud Free - type: free - applications_total: 3 - applications_used: 1 - organization: - uuid: 39f38840-c494-4622-80a5-fc40269cb42d - name: Acquia Inc. - flags: - active: true - expired: true - zuora: false - _links: - self: - href: 'https://cloud.acquia.com/api/subscriptions/faa297f3-f59a-4abc-8d71-904f51bcb1c5' - _embedded: - organization: - uuid: 39f38840-c494-4622-80a5-fc40269cb42d - name: Acquia Inc. - _links: - self: - href: 'https://cloud.acquia.com/api/organizations/39f38840-c494-4622-80a5-fc40269cb42d' - parent: - href: 'https://cloud.acquia.com/api/organizations' - - id: 222 - uuid: 36496037-6eb5-482d-8549-e45e1718f2b7 - name: My Acquia Subscription - start_at: '2012-05-15T12:00:00Z' - expire_at: '2015-05-15T12:00:00Z' - product: - id: 8999 - name: Enterprise - type: enterprise - applications_total: 5 - applications_used: 2 + - id: 241643 + uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470 + name: Sample application 1 + hosting: + type: acp + id: devcloud:devcloud2 + subscription: + uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470 + name: Sample subscription organization: - uuid: 93c97126-2870-47f0-9ffd-9a92033c443e - name: My Organization + uuid: 6a907396-abfd-4d01-9da6-64c8efc04519 + name: Sample organization flags: - active: true - expired: true - zuora: false + remote_admin: true + status: normal + type: drupal _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/36496037-6eb5-482d-8549-e45e1718f2b7' - _embedded: - organization: - uuid: 93c97126-2870-47f0-9ffd-9a92033c443e - name: My Organization - _links: - self: - href: 'https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e' - parent: - href: 'https://cloud.acquia.com/api/organizations' - - id: 333 - uuid: 2d92f652-882c-458a-8183-4d9cef7c2fde - name: My Acquia Subscription 2 - start_at: '2012-05-15T12:00:00Z' - expire_at: '2015-05-15T12:00:00Z' - product: - id: 8999 - name: Enterprise - type: enterprise - applications_total: 5 - applications_used: 2 + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470 + - id: 954291 + uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471 + name: Sample application 2 + hosting: + type: free + id: devcloud:devcloud2 + subscription: + uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470 + name: Sample subscription organization: - uuid: 93c97126-2870-47f0-9ffd-9a92033c443e - name: My Organization + uuid: 6a907396-abfd-4d01-9da6-64c8efc04519 + name: Sample organization flags: - active: true - expired: true - zuora: false + remote_admin: false + status: provisioning + type: drupal _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/2d92f652-882c-458a-8183-4d9cef7c2fde' - _embedded: - organization: - uuid: 93c97126-2870-47f0-9ffd-9a92033c443e - name: My Organization - _links: - self: - href: 'https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e' - parent: - href: 'https://cloud.acquia.com/api/organizations' - '404': + href: https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471 + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' - examples: - Not found: - value: - error: not_found - message: You do not have permission to view subscriptions. - '/subscriptions/{subscriptionUuid}': + $ref: "#/components/schemas/Error" + example: + error: not_found + message: You do not have permission to view applications. + "/subscriptions/{subscriptionUuid}/code-studio": get: tags: - Subscriptions - summary: Return details about a specific subscription. - description: Return details about a specific subscription. - operationId: getSubscription - x-cli-name: 'subscriptions:find' + summary: Retrieves Code Studio metadata for a subscription. + description: Retrieves Code Studio metadata for a subscription. + operationId: getCodeStudioSubscriptionMetadata security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/CodeStudioSubscriptionMetadata" example: - id: 329876 - uuid: 8533debb-ae4e-427b-aa34-731719b4201a - name: My Subscription - start_at: '2015-05-13T00:00:00' - expire_at: '2018-05-12T00:00:00' - product: - id: 8999 - name: Enterprise - type: enterprise - applications_total: 10 - applications_used: 0 - organization: - uuid: 93c97126-2870-47f0-9ffd-9a92033c443e - name: My Organization - flags: - active: true - expired: true - zuora: false _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a' - applications: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications' - entitlements: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/entitlements' - ides: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/ides' - shield-acl: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/shield-acl' + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio + subscription: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342 parent: - href: 'https://cloud.acquia.com/api/subscriptions' + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342 + users: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users + applications: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications + code-studio: + href: https://code.acquia.com + code-studio-api: + href: https://code.acquia.com/api/v4 _embedded: - organization: - uuid: 93c97126-2870-47f0-9ffd-9a92033c443e - name: My Organization + subscription: _links: self: - href: 'https://cloud.acquia.com/api/organizations/93c97126-2870-47f0-9ffd-9a92033c443e' - parent: - href: 'https://cloud.acquia.com/api/organizations' - '404': + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342 + uuid: e5bfb18f-2c6c-4534-bb9b-15ba73e17342 + name: My Subscription + status: active + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No entitlement: + value: + error: forbidden + message: Code Studio is not available for this subscription. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - put: + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + options: tags: - Subscriptions - summary: Modifies a subscription. - description: Modifies a subscription. - operationId: putSubscription - x-cli-name: 'subscriptions:update' + summary: Displays Code Studio options for a subscription. + description: Displays Code Studio options for a subscription. + operationId: optionsCodeStudio security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - requestBody: - required: true - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - name: - type: string - description: The new subscription name. - maxLength: 255 + - $ref: "#/components/parameters/SubscriptionUuid" + responses: + "200": + description: OK + content: + application/hal+json: + schema: + $ref: "#/components/schemas/CodeStudioOptions" + example: + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio + parent: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342 + roles: + a9bdb481-63f4-4770-93ee-bf6c630238cf: Guest + c6c76597-dd30-4149-8a76-3c58d764bc66: Reporter + 4a996644-5a6e-4403-9306-6c08cb212ee1: Developer + 90abb6cc-f609-41db-a92d-1900b1c7d93f: Maintainer + e62722c0-64dc-4d87-88ac-9f7bef645572: Owner + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No entitlement: + value: + error: forbidden + message: Code Studio is not available for this subscription. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No subscription or permission: + value: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/code-studio/actions/enable": + post: + tags: + - Subscriptions + summary: Enables Code Studio for a subscription. + description: Enables and provisions Code Studio at the subscription level. + operationId: postEnableCodeStudio + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/SubscriptionUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: + schema: + $ref: "#/components/schemas/MessageWithLinks" + example: + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/actions/enable + notification: + href: https://cloud.acquia.com/api/notifications/34c7ed7e-2db8-433f-b6a8-96bc1080e3c9 + notification_id: 34c7ed7e-2db8-433f-b6a8-96bc1080e3c9 + message: Code Studio has been enabled for the Subscription. + "403": + description: Forbidden + content: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Error" examples: - Subscription updated: + No permission: value: - message: Subscription updated. - '404': + error: forbidden + message: You do not have permission to enable Code Studio for this subscription. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: - Validation failed: + No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/apm': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/code-studio/applications": get: tags: - - Application Performance Monitoring Services - summary: Returns a list of Application Performance Monitoring services associated with the subscription. - description: Returns a list of Application Performance Monitoring services associated with the subscription. - operationId: getSubscriptionApmTypes - x-cli-name: 'subscriptions:apm-list' + - Subscriptions + summary: Retrieves a list of Code Studio enabled applications for a subscription. + description: Retrieves a list of Code Studio enabled applications for a subscription. + operationId: getCodeStudioApplications + security: + - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApmTypes' + $ref: "#/components/schemas/CodeStudioApplications" example: total: 1 + pagination: + limit: 10 + total: 1 + offset: 0 _links: - self: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm' parent: - href: 'https://cloud.acquia.com/api/subscriptions' - sort: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm{?sort}' - templated: true + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342 + code-studio: + href: https://code.acquia.com + code-studio-api: + href: https://code.acquia.com/api/v4 + self: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1 filter: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm{?filter}' + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1{&filter} + templated: true + sort: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/applications?offset=1{&sort} templated: true _embedded: items: - - type: newrelic - flags: - opted-in: true - key: 2d1dfa83d5e1494793957e7ce572942b - _links: + - _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm/newrelic' + href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343 + project: + href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343/code-studio parent: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm' - '403': + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342 + _embedded: + project: + _links: + self: + href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343/code-studio + parent: + href: https://cloud.acquia.com/api/applications/b91be25b-8eba-4ff7-94c8-d51637da2343 + code-studio: + href: https://code.acquia.com/path/to/project + code-studio-api: + href: https://code.acquia.com/api/v4/path/to/project + application_id: b91be25b-8eba-4ff7-94c8-d51637da2343 + status: active + uuid: b91be25b-8eba-4ff7-94c8-d51637da2343 + name: My Application + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' - example: - error: forbidden - message: You do not have permission to access APM summaries for this subscription. - '404': + $ref: "#/components/schemas/Error" + examples: + No entitlement: + value: + error: forbidden + message: Code Studio is not available for this subscription. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' - example: - error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/apm/{apmType}': + $ref: "#/components/schemas/Error" + examples: + No subscription or permission: + value: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/code-studio/users": get: tags: - - Application Performance Monitoring Services - summary: Returns the Application Performance Monitoring service type associated with the subscription. - description: Returns the Application Performance Monitoring service type associated with the subscription. - operationId: getSubscriptionApmType - x-cli-name: 'subscriptions:apm-list' + - Subscriptions + summary: Retrieves a list of users assigned to Code Studio for a subscription. + description: Retrieves a list of users assigned to Code Studio for a subscription. + operationId: getCodeStudioUsers + security: + - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/ApmType' + - $ref: "#/components/parameters/SubscriptionUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ApmType' + $ref: "#/components/schemas/CodeStudioUsers" example: - type: newrelic - flags: - opted-in: true - key: 2d1dfa83d5e1494793957e7ce572942b + total: 1 + pagination: + limit: 10 + total: 1 + offset: 0 _links: - self: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a' parent: - href: 'https://cloud.acquia.com/api/subscriptions' - '403': + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio + self: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users + code-studio: + href: https://code.acquia.com + code-studio-api: + href: https://code.acquia.com/api/v4 + filter: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users{?filter} + templated: true + sort: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users{?sort} + templated: true + _embedded: + items: + - _links: + self: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users/cc27c5b6-d641-4e72-8897-75874ecf82e6 + parent: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users + code-studio: + href: https://code.acquia.com + code-studio-api: + href: https://code.acquia.com/api/v4 + uuid: cc27c5b6-d641-4e72-8897-75874ecf82e6 + first_name: Jane + last_name: Doe + mail: jane.doe@test.com + role: b3d8e9f1-8cb6-43c0-b579-0c465f5fdf49 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' - example: - error: forbidden - message: You do not have permission to access this APM summary type. - '404': + $ref: "#/components/schemas/Error" + examples: + No entitlement: + value: + error: forbidden + message: Code Studio is not available for this subscription. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' - example: - error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/apm/{apmType}/actions/opt-in': + $ref: "#/components/schemas/Error" + examples: + No subscription or permission: + value: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. post: tags: - - Application Performance Monitoring Services - summary: Enables New Relic Pro APM license for all applications on a subscription. - description: Enables New Relic Pro APM license for all applications on a subscription. This authorizes Acquia to create a new user account on the third-party New Relic platform using the name and e-mail address of the organization owner. - operationId: postSubscriptionApmOptIn - x-cli-name: 'subscriptions:apm-opt-in' - parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/ApmType' + - Subscriptions + summary: Assigns a user to a Code Studio seat for a subscription. + description: Assigns a user to Code Studio seat for a subscription. + operationId: postCodeStudioUsers security: - OAuth2: [] + parameters: + - $ref: "#/components/parameters/SubscriptionUuid" + requestBody: + required: true + content: + application/hal+json: + schema: + type: object + properties: + user_id: + type: string + description: The ID of the user to assign. + role: + type: string + description: The ID of the Code Studio role to assign to the user. + example: + user_id: 0b9bea4e-f469-44dd-a4b6-965aad734198 + role: ba8e9a8b-5e98-43b0-a0ec-40b2a813879a responses: - '200': + "200": description: OK content: - application/json: - schema: - $ref: '#/components/schemas/MessageWithLinks' - examples: - APM Type Enabled: - value: - message: APM type newrelic has been enabled on the example subscription. - _links: - self: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm/newrelic/actions/opt-in' - parent: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/apm/newrelic/actions' - notification: - href: 'https://cloud.acquia.com/api/notifications/7b37b885-8ae4-454b-b8fa-ffaeff54f6a4' - '400': - description: Bad Request - content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' - examples: - APM type unavailable: - value: - error: validation_failed - message: - name: New Relic is not available for this subscription. - Must be organization owner: - value: - error: validation_failed - message: - name: Only the organization owner may opt into data sharing. - '403': + $ref: "#/components/schemas/MessageWithLinks" + example: + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users + notification: + href: https://cloud.acquia.com/api/notifications/4e3cae56-5547-4ac7-b552-5dc87b50a8d3 + message: A Code Studio user has been added to the Subscription. + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: - Insufficient permissions: + No permission: value: error: forbidden - message: You do not have permission to opt-in to APM settings for this subscription. - '404': + message: You do not have permission to add a Code Studio user to this Subscription. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: - Not found: + No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/applications': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/code-studio/users/{userUuid}": get: tags: - Subscriptions - summary: Provides a list of applications that are a part of the subscription. - description: | - Filterable fields: - * `from` - * `to` - * `sort` - * `filter` - * `limit` - * `offset` - - Sortable fields: - * `from` - * `to` - * `sort` - * `filter` - * `limit` - * `offset` - operationId: getSubscriptionApplications - x-cli-name: 'subscriptions:application-list' + summary: Retrieves details about a specific Code Studio user. + description: Retrieves details about a specific Code Studio user. + operationId: getCodeStudioUser + security: + - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/UserUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Applications' + $ref: "#/components/schemas/CodeStudioUser" example: - total: 2 - pagination: - total: 2 - limit: 10 - offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications' + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users/bd06a2fe-a103-400e-b397-b4d27538e1b3 parent: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a' - sort: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?sort}' - templated: true - filter: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?filter}' - templated: true - limit: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/applications{?limit}' - templated: true - _embedded: - items: - - id: 241643 - uuid: a47ac10b-58cc-4372-a567-0e02b2c3d470 - name: Sample application 1 - hosting: - type: acp - id: 'devcloud:devcloud2' - subscription: - uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470 - name: Sample subscription - organization: - uuid: 6a907396-abfd-4d01-9da6-64c8efc04519 - name: Sample organization - flags: - remote_admin: true - status: normal - type: drupal - _links: - self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470' - - id: 954291 - uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471 - name: Sample application 2 - hosting: - type: free - id: 'devcloud:devcloud2' - subscription: - uuid: f47ac10b-58cc-4372-a567-0e02b2c3d470 - name: Sample subscription - organization: - uuid: 6a907396-abfd-4d01-9da6-64c8efc04519 - name: Sample organization - flags: - remote_admin: false - status: provisioning - type: drupal - _links: - self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471' - '404': + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users + code-studio: + href: https://code.acquia.com + code-studio-api: + href: https://code.acquia.com/api/v4 + uuid: bd06a2fe-a103-400e-b397-b4d27538e1b3 + first_name: Jane + last_name: Doe + mail: jane.doe@test.com + role: 90ad1576-84d9-43e5-b9db-0aad54dd5ade + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No entitlement: + value: + error: forbidden + message: Code Studio is not available for this subscription. + "404": description: Not Found content: - application/json: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No subscription or permission: + value: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + Code Studio user not found: + value: + error: not_found + message: The Code Studio user you are trying to access does not exist, or you do not have permission to access it. + delete: + tags: + - Subscriptions + summary: Unassigns a user from a Code Studio seat. + description: Unassigns a user from a Code Studio seat. + operationId: deleteCodeStudioUser + security: + - OAuth2: [] + parameters: + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/UserUuid" + responses: + "200": + description: OK + content: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/MessageWithLinks" example: - error: not_found - message: You do not have permission to view applications. - '/subscriptions/{subscriptionUuid}/domains': + _links: + self: + href: https://cloud.acquia.com/api/subscriptions/e5bfb18f-2c6c-4534-bb9b-15ba73e17342/code-studio/users + notification: + href: https://cloud.acquia.com/api/notifications/4e3cae56-5547-4ac7-b552-5dc87b50a8d3 + message: The Code Studio user is being removed from the Subscription. + "403": + description: Forbidden + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No permission: + value: + error: forbidden + message: You do not have permission to remove the Code Studio user from this Subscription. + "404": + description: Not Found + content: + application/hal+json: + schema: + $ref: "#/components/schemas/Error" + examples: + No subscription or permission: + value: + error: not_found + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/domains": get: tags: - Subscriptions summary: Returns a list of Domains registered with this subscription. description: Returns a list of Domains registered with this subscription. operationId: getSubscriptionDomainRegistrations - x-cli-name: 'subscriptions:domain-registrations-list' + x-cli-name: subscriptions:domain-registrations-list parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/DomainRegistrations' + $ref: "#/components/schemas/DomainRegistrations" example: total: 2 pagination: @@ -25999,27 +27515,27 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains parent: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000 limit: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?limit}' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?offset}' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?offset} templated: true sort: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?sort}' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?filter}' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains{?filter} templated: true _embedded: items: - uuid: 123e4567-e89b-12d3-a456-426614174000 domain_name: example.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM/SPF/TXT DNS record. summary: Missing DNS record dns_records: @@ -26027,60 +27543,60 @@ paths: name: _amazonses.example.com value: AB/CD4Hef1+c0D7+wYS2xQ+EBr3HZiXRWDJHrjEWOhs= health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required TXT DNS record summary: Missing DNS record - type: TXT name: _acquiaplatform.example.com - value: 'aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43=' + value: aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43= health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required TXT DNS record summary: Missing DNS record - type: MX name: mail.example.com value: 10 feedback-smtp.us-east-1.amazonses.com health: - code: '202' + code: "202" details: Acquia is in the process of verifying SPF DNS records. summary: Verification pending - type: TXT name: mail.example.com - value: 'v=spf1 include:amazonses.com ~all' + value: v=spf1 include:amazonses.com ~all health: - code: '202' + code: "202" details: Acquia is in the process of verifying SPF DNS records. summary: Verification pending - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000 parent: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains - uuid: 123e4567-e89b-12d3-a456-426614174000 domain_name: example2.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM/SPF/TXT DNS record. summary: Missing DNS record dns_records: @@ -26088,97 +27604,97 @@ paths: name: _amazonses.example2.com value: AB/CD4Hef1+c0D7+wYS2xQ+EBr3HZiXRWDJHrjEWOhs= health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required TXT DNS record summary: Missing DNS record - type: TXT name: _acquiaplatform.example2.com - value: 'aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43=' + value: aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43= health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required TXT DNS record summary: Missing DNS record - type: MX name: mail.example2.com value: 10 feedback-smtp.us-east-1.amazonses.com health: - code: '202' + code: "202" details: Acquia is in the process of verifying SPF DNS records. summary: Verification pending - type: TXT name: mail.example2.com - value: 'v=spf1 include:amazonses.com ~all' + value: v=spf1 include:amazonses.com ~all health: - code: '202' + code: "202" details: Acquia is in the process of verifying SPF DNS records. summary: Verification pending - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example2.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example2.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example2.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000 parent: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains' - '403': + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to manage domain registrations for this subscription. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' + message: The subscription you are trying to access does not exist, or you do not have permission to access it. post: tags: - Subscriptions summary: Registers a Domain with this subscription. description: Registers a Domain with this subscription. operationId: postSubscriptionDomainRegistration - x-cli-name: 'subscriptions:post-domain-registration' + x-cli-name: subscriptions:post-domain-registration parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: domain: type: string - format: uri + format: hostname description: The domain name to add. minLength: 3 maxLength: 253 @@ -26196,53 +27712,53 @@ paths: example: domain: example.com responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The domain has been registered. _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000 parent: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains notification: - href: 'https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000' - '403': + href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to manage domain registrations for this subscription. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' + message: The subscription you are trying to access does not exist, or you do not have permission to access it. No domain or permission: value: error: not_found - message: 'The domain registration you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The domain registration you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No entitlement: value: @@ -26252,29 +27768,29 @@ paths: value: error: conflict message: The maximum number of domains for Platform Email have been registered. - '/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}': + "/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}": get: tags: - Subscriptions summary: Returns a speicific Domain registered with this subscription. description: Returns a speicific Domain registered with this subscription. operationId: getSubscriptionDomainRegistration - x-cli-name: 'subscriptions:get-domain-registration' + x-cli-name: subscriptions:get-domain-registration parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/DomainRegistrationUuid' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/DomainRegistrationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/DomainRegistration' + $ref: "#/components/schemas/DomainRegistration" example: uuid: 123e4567-e89b-12d3-a456-426614174000 domain_name: example.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM/SPF/TXT DNS record. summary: Missing DNS record dns_records: @@ -26282,129 +27798,129 @@ paths: name: _amazonses.example.com value: AB/CD4Hef1+c0D7+wYS2xQ+EBr3HZiXRWDJHrjEWOhs= health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required TXT DNS record summary: Missing DNS record - type: TXT name: _acquiaplatform.example.com - value: 'aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43=' + value: aGh54oW35sd5LMGhas1fWrnRrticnsdndf,43= health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required TXT DNS record summary: Missing DNS record - type: MX name: mail.example.com value: 10 feedback-smtp.us-east-1.amazonses.com health: - code: '202' + code: "202" details: Acquia is in the process of verifying SPF DNS records. summary: Verification pending - type: TXT name: mail.example.com - value: 'v=spf1 include:amazonses.com ~all' + value: v=spf1 include:amazonses.com ~all health: - code: '202' + code: "202" details: Acquia is in the process of verifying SPF DNS records. summary: Verification pending - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record - type: CNAME name: abcdefgh1ijkl2mnopq34rstuvwxyz._domainkey.example.com value: abcdefgh1ijkl2mnopq34rstuvwxyz.dkim.amazonses.com health: - code: '404' + code: "404" details: Acquia could not verify the presence of the required DKIM DNS record summary: Missing DNS record _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000 parent: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains' - '404': + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' + message: The subscription you are trying to access does not exist, or you do not have permission to access it. No domain or permission: value: error: not_found - message: 'The domain registration you are trying to access does not exist, or you do not have permission to access it.' + message: The domain registration you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Subscriptions summary: Unregisters a Domain registered with this subscription. description: Unregisters a Domain registered with this subscription. operationId: deleteSubscriptionDomainRegistration - x-cli-name: 'subscriptions:delete-domain-registration' + x-cli-name: subscriptions:delete-domain-registration parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/DomainRegistrationUuid' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/DomainRegistrationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The domain has been unregistered from the subscription. _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000 parent: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains notification: - href: 'https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000' - '403': + href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to remove domains from this subscription. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' + message: The subscription you are trying to access does not exist, or you do not have permission to access it. No domain or permission: value: error: not_found - message: 'The domain you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The domain you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No entitlement: value: @@ -26414,50 +27930,50 @@ paths: value: error: conflict message: example.com is not registered with this subscription. - '/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}/actions/verify': + "/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}/actions/verify": post: tags: - Subscriptions summary: Triggers re-verification and update to the domain verification status. description: Triggers re-verification and update to the domain verification status. operationId: postSubscriptionVerifyDomainRegistration - x-cli-name: 'subscriptions:post-verify-domain-registration' + x-cli-name: subscriptions:post-verify-domain-registration parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/DomainRegistrationUuid' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/DomainRegistrationUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: The domain status is being verified. _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000/actions/verify' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000/actions/verify parent: - href: 'https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000' + href: https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/domains/123e4567-e89b-12d3-a456-426614174000 notification: - href: 'https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000' - '403': + href: https://cloud.acquia.com/api/notifications/123e4567-e89b-12d3-a456-426614174000 + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No domain or permission: value: error: not_found - message: 'The domain registration you are trying to access does not exist, or you do not have permission to access it.' - '404': + message: The domain registration you are trying to access does not exist, or you do not have permission to access it. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: @@ -26466,13 +27982,13 @@ paths: No domain or permission: value: error: not_found - message: 'The domain registration you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The domain registration you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No entitlement: value: @@ -26482,100 +27998,136 @@ paths: value: error: conflict message: This domain cannot be reverified at this time. - '/subscriptions/{subscriptionUuid}/entitlements': + "/subscriptions/{subscriptionUuid}/entitlements": get: tags: - Subscriptions summary: Provides a list of entitlements that are a part of the subscription. description: Provides a list of entitlements that are a part of the subscription. operationId: getSubscriptionEntitlements - x-cli-name: 'subscriptions:entitlements-list' + x-cli-name: subscriptions:entitlements-list parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Entitlements' + $ref: "#/components/schemas/Entitlements" example: _embedded: items: - name: cde + offering_ids: + - b2a188df-00b7-47bf-a664-66835cde53b0 + expires_at: '2023-05-16T11:15:05+00:00' + flags: + trial: true properties: databases_total: 3 total: 10 used: 1 - name: pipelines + offering_ids: + - b2a188df-00b7-47bf-a664-66835cde53b0 + expires_at: '2023-05-16T11:15:05+00:00' + flags: + trial: true properties: [] - name: newrelic + offering_ids: + - b2a188df-00b7-47bf-a664-66835cde53b0 + expires_at: '2023-05-16T11:15:05+00:00' + flags: + trial: true properties: id: 03816870a4724c900292bc9f0955a315 level: pro - name: log-forwarding + offering_ids: + - b2a188df-00b7-47bf-a664-66835cde53b0 + expires_at: '2023-05-16T11:15:05+00:00' + flags: + trial: true properties: [] - name: shield + offering_ids: + - b2a188df-00b7-47bf-a664-66835cde53b0 + expires_at: '2023-05-16T11:15:05+00:00' + flags: + trial: true properties: [] - name: consumption-based-pricing + offering_ids: + - b2a188df-00b7-47bf-a664-66835cde53b0 + expires_at: '2023-05-16T11:15:05+00:00' + flags: + trial: true properties: visits: 10000000 views: 500000000 - name: migrate-accelerator + offering_ids: + - b2a188df-00b7-47bf-a664-66835cde53b0 + expires_at: '2023-05-16T11:15:05+00:00' + flags: + trial: true properties: [] _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/entitlements' + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a/entitlements parent: - href: 'https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a' - '404': + href: https://cloud.acquia.com/api/subscriptions/8533debb-ae4e-427b-aa34-731719b4201a + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/ides': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/ides": get: tags: - Subscriptions summary: Returns a list of Cloud IDEs associated with this subscription. description: Returns a list of Cloud IDEs associated with this subscription. operationId: getSubscriptionIdes - x-cli-name: 'subscriptions:ide-list' + x-cli-name: subscriptions:ide-list parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Ides' + $ref: "#/components/schemas/Ides" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/5d278c52-4876-4c70-a666-d671f77a602d/ides' + href: https://cloud.acquia.com/api/subscriptions/5d278c52-4876-4c70-a666-d671f77a602d/ides parent: - href: 'https://cloud.acquia.com/api/subscriptions/5d278c52-4876-4c70-a666-d671f77a602d' + href: https://cloud.acquia.com/api/subscriptions/5d278c52-4876-4c70-a666-d671f77a602d _embedded: items: - uuid: 9a83c081-ef78-4dbd-8852-11cc3eb248f7 label: IDE Label 1 + status: active _links: self: - href: 'https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7' + href: https://cloud.acquia.com/api/ides/9a83c081-ef78-4dbd-8852-11cc3eb248f7 web: - href: 'https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud' + href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.web.ahdev.cloud ide: - href: 'https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ides.acquia.com' + href: https://9a83c081-ef78-4dbd-8852-11cc3eb248f7.ides.acquia.com application: - href: 'https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199' + href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199 _embedded: owner: uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd @@ -26584,19 +28136,20 @@ paths: last_login_at: '2019-01-31T10:53:11-05:00' created_at: '2016-08-14T17:38:59-04:00' email: user.name@example.com - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name - uuid: feea197a-9503-4441-9f49-b4d420b0ecf8 label: IDE Label 2 + status: active _links: self: - href: 'https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8' + href: https://cloud.acquia.com/api/ides/feea197a-9503-4441-9f49-b4d420b0ecf8 web: - href: 'https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud' + href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.web.ahdev.cloud ide: - href: 'https://feea197a-9503-4441-9f49-b4d420b0ecf8.ides.acquia.com' + href: https://feea197a-9503-4441-9f49-b4d420b0ecf8.ides.acquia.com application: - href: 'https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199' + href: https://cloud.acquia.com/api/applications/461fe350-7988-42b3-a73e-cffcdbb94199 _embedded: owner: uuid: 10be1d3e-f2b4-4d34-855d-321df3938ffd @@ -26605,79 +28158,79 @@ paths: last_login_at: '2019-01-31T10:53:11-05:00' created_at: '2016-08-14T17:38:59-04:00' email: user.name@example.com - picture_url: 'https://accounts.acquia.com/path/to/image.png' + picture_url: https://accounts.acquia.com/path/to/image.png username: user.name - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/metrics/usage': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/metrics/usage": get: tags: - Subscriptions summary: Retrieves traversal links for a subscription's usage data. description: Retrieves traversal links for a subscription's usage data. operationId: getSubscriptionsUsageLinks - x-cli-name: 'subscriptions:usage-links' + x-cli-name: subscriptions:usage-links parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Usage' + $ref: "#/components/schemas/Usage" example: _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage parent: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics data: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data data-by-application: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application views: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views views-by-application: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application visits: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits visits-by-application: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application' - '403': + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this subscription. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Subscription not found: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/metrics/usage/data': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/metrics/usage/data": get: tags: - Subscriptions @@ -26689,38 +28242,38 @@ paths: * `from` * `to` operationId: getSubscriptionsUsageData - x-cli-name: 'subscriptions:usage-data' + x-cli-name: subscriptions:usage-data parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SubscriptionUsageMetrics' + $ref: "#/components/schemas/SubscriptionUsageMetrics" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data parent: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage filter: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data{?filter}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data{?filter} templated: true _embedded: items: - metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -26731,15 +28284,15 @@ paths: - 1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage - metric: visits datapoints: - - '2019-03-13T00:00:00+00:00' - - '3' + - "3" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -26750,57 +28303,57 @@ paths: - 1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage' - '403': + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this subscription. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/metrics/usage/data-by-application': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/metrics/usage/data-by-application": get: tags: - Subscriptions - summary: 'Retrieves usage data for a subscription, broken down by application.' + summary: Retrieves usage data for a subscription, broken down by application. description: | Filterable fields: * `metric` - One of: {`views`, `visits`} * `application` operationId: getSubscriptionsUsageDataByApplication - x-cli-name: 'subscriptions:usage-data-by-application' + x-cli-name: subscriptions:usage-data-by-application parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SubscriptionUsageMetrics' + $ref: "#/components/schemas/SubscriptionUsageMetrics" example: total: 2 pagination: @@ -26809,26 +28362,26 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application parent: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage limit: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?limit}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?offset}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?offset} templated: true filter: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?filter}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/data-by-application{?filter} templated: true _embedded: items: - metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -26844,15 +28397,15 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage - metric: visits datapoints: - - '2019-03-13T00:00:00+00:00' - - '3' + - "3" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -26868,32 +28421,32 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/metrics/usage/{usageMetric}': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/metrics/usage/{usageMetric}": get: tags: - Subscriptions @@ -26902,28 +28455,28 @@ paths: Filterable fields: * `application` operationId: getSubscriptionsUsageMetricData - x-cli-name: 'subscriptions:usage-metric-data' + x-cli-name: subscriptions:usage-metric-data parameters: - - $ref: '#/components/parameters/UsageMetric' - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' + - $ref: "#/components/parameters/UsageMetric" + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SubscriptionUsageMetric' + $ref: "#/components/schemas/SubscriptionUsageMetric" example: metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -26934,56 +28487,56 @@ paths: - 1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage' - '403': + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/metrics/usage/views-by-application': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/metrics/usage/views-by-application": get: tags: - Subscriptions - summary: 'Retrieves views data for a subscription, broken down by application.' + summary: Retrieves views data for a subscription, broken down by application. description: | Filterable fields: * `application` operationId: getSubscriptionsUsageViewsDataByApplication - x-cli-name: 'subscriptions:usage-views-data-by-application' + x-cli-name: subscriptions:usage-views-data-by-application parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SubscriptionUsageMetrics' + $ref: "#/components/schemas/SubscriptionUsageMetrics" example: total: 2 pagination: @@ -26992,26 +28545,26 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application parent: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage limit: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?limit}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?offset}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?offset} templated: true filter: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?filter}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/views-by-application{?filter} templated: true _embedded: items: - metric: views datapoints: - - '2019-03-13T00:00:00+00:00' - - '9' + - "9" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -27027,56 +28580,56 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/views parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/metrics/usage/visits-by-application': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/metrics/usage/visits-by-application": get: tags: - Subscriptions - summary: 'Retrieves visits data for a subscription, broken down by application.' + summary: Retrieves visits data for a subscription, broken down by application. description: | Filterable fields: * `application` operationId: getSubscriptionsUsageVisitsDataByApplication - x-cli-name: 'subscriptions:usage-visits-data-by-application' + x-cli-name: subscriptions:usage-visits-data-by-application parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/From' - - $ref: '#/components/parameters/To' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Resolution' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/From" + - $ref: "#/components/parameters/To" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Resolution" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/SubscriptionUsageMetrics' + $ref: "#/components/schemas/SubscriptionUsageMetrics" example: total: 2 pagination: @@ -27085,26 +28638,26 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application parent: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage limit: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?limit}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?limit} templated: true offset: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?offset}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?offset} templated: true filter: - href: 'https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?filter}' + href: https://cloud.acquia.com/api/subscriptions/9567a611-4cdd-4586-8b3f-f3980a87e471/metrics/usage/visits-by-application{?filter} templated: true _embedded: items: - metric: visits datapoints: - - '2019-03-13T00:00:00+00:00' - - '3' + - "3" - - '2019-03-14T00:00:00+00:00' - - '1' + - "1" last_data_at: '2019-03-14T00:00:00+00:00' metadata: subscription: @@ -27120,57 +28673,57 @@ paths: - 125-1df8bff7-ffda-4571-b64a-f90f60f4dbf8 _links: self: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits' + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage/visits parent: - href: 'https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage' - '403': + href: https://cloud.acquia.com/api/applications/1df8bff7-ffda-4571-b64a-f90f60f4dbf8/metrics/usage + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to view usage metrics for this application. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application not found: value: error: not_found - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '/subscriptions/{subscriptionUuid}/shield-acl': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "/subscriptions/{subscriptionUuid}/shield-acl": get: tags: - Subscriptions summary: Provides a list of Shield ACL rules. description: Provides a list of Shield ACL rules. operationId: getShieldAcl - x-cli-name: 'subscriptions:shield-acl-list' + x-cli-name: subscriptions:shield-acl-list parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ShieldAclCollection' + $ref: "#/components/schemas/ShieldAclCollection" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/abcd1234-58cc-4372-a567-0e02b2c3d470/shield-acl' + href: https://cloud.acquia.com/api/subscriptions/abcd1234-58cc-4372-a567-0e02b2c3d470/shield-acl parent: - href: 'https://cloud.acquia.com/api/subscriptions/abcd1234-58cc-4372-a567-0e02b2c3d470' + href: https://cloud.acquia.com/api/subscriptions/abcd1234-58cc-4372-a567-0e02b2c3d470 _embedded: items: - uuid: d5afa695-92a0-401b-b973-1f09992d6ba2 @@ -27186,9 +28739,9 @@ paths: status: active _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba2' + href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba2 parent: - href: 'https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl' + href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl - uuid: d5afa695-92a0-401b-b973-1f09992d6ba3 subscription: uuid: 720d4df4-7469-47f2-9e42-a6a5152761bf @@ -27201,42 +28754,42 @@ paths: status: active _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba3' + href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba3 parent: - href: 'https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl' - '403': + href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl + "403": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: not_found message: You do not have permission to view the Shield ACL rules for subscription d17b25bb-28dd-4a24-8f89-bfe8b1e151e9. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' + message: The subscription you are trying to access does not exist, or you do not have permission to access it. post: tags: - Subscriptions summary: Creates a Shield ACL rule. description: Creates a Shield ACL rule. operationId: postShieldAcl - x-cli-name: 'subscriptions:shield-acl-create' + x-cli-name: subscriptions:shield-acl-create security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" requestBody: required: true content: @@ -27256,27 +28809,27 @@ paths: type: string description: An IP address and/or CIDRs for this Shield ACL rule. responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Shield ACL rule for subscription has been created. _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl/bf8b6858-1e36-4b8e-bb05-35bdd986f5d2' + href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl/bf8b6858-1e36-4b8e-bb05-35bdd986f5d2 parent: - href: 'https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl' + href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl notification: - href: 'https://cloud.acquia.com/api/notifications/fbd0581d-7606-43d0-9d2e-4d9fa6570a0d' - '400': + href: https://cloud.acquia.com/api/notifications/fbd0581d-7606-43d0-9d2e-4d9fa6570a0d + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Acquia Shield not available: value: @@ -27288,59 +28841,59 @@ paths: error: validation_failed message: general: You have already used the maximum number of Shield rules for this subscription. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found message: You do not have permission to create a new Shield ACL rule. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Shield ACL updates in progress: value: error: conflict message: general: Shield ACL rules cannot be created while ACL rule updates are in progress. - '/subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}': + "/subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}": get: tags: - Subscriptions summary: Returns the specified Shield ACL rule. operationId: getShieldAclRuleByUuid - x-cli-name: 'subscriptions:shield-acl-find' + x-cli-name: subscriptions:shield-acl-find security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/ShieldAclUuid' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/ShieldAclUuid" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ShieldAcl' + $ref: "#/components/schemas/ShieldAcl" example: uuid: d5afa695-92a0-401b-b973-1f09992d6ba2 subscription: @@ -27355,47 +28908,47 @@ paths: status: active _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba2' + href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/d5afa695-92a0-401b-b973-1f09992d6ba2 parent: - href: 'https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl' - '403': + href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to view the Shield ACL rules for subscription 720d4df4-7469-47f2-9e42-a6a5152761bf - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No Shield Acl: value: error: not_found - message: 'The Shield ACL rule you are trying to access does not exist, or you do not have permission to access it.' + message: The Shield ACL rule you are trying to access does not exist, or you do not have permission to access it. No subscription: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' + message: The subscription you are trying to access does not exist, or you do not have permission to access it. put: tags: - Subscriptions summary: Updates a Shield ACL rule. description: Updates a Shield ACL rule. operationId: putShieldAcl - x-cli-name: 'subscriptions:shield-acl-update' + x-cli-name: subscriptions:shield-acl-update security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/ShieldAclUuid' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/ShieldAclUuid" requestBody: required: true content: @@ -27415,49 +28968,49 @@ paths: type: string description: An IP address and/or CIDRs for this Shield ACL rule. responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Updated ACL rule for subscription. _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl/b23588f8-dbfa-4fb8-92a1-60e0dd08eee9' + href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl/b23588f8-dbfa-4fb8-92a1-60e0dd08eee9 parent: - href: 'https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl' + href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl notification: - href: 'https://cloud.acquia.com/api/notifications/87ae4d57-24d6-4b4b-8552-d9658b4e2dea' - '403': + href: https://cloud.acquia.com/api/notifications/87ae4d57-24d6-4b4b-8552-d9658b4e2dea + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to edit a Shield ACL rule. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Validation failed: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' - '409': + message: The subscription you are trying to access does not exist, or you do not have permission to access it. + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Validation failed: value: @@ -27473,34 +29026,34 @@ paths: summary: Deletes a Shield ACL rule. description: Deletes a Shield ACL rule. operationId: deleteShieldAcl - x-cli-name: 'subscriptions:shield-acl-delete' + x-cli-name: subscriptions:shield-acl-delete security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/SubscriptionUuid' - - $ref: '#/components/parameters/ShieldAclUuid' + - $ref: "#/components/parameters/SubscriptionUuid" + - $ref: "#/components/parameters/ShieldAclUuid" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: - message: 'Deleted ACL rule (UUID: 93136254-7d65-465c-82e9-5e92d74ae6b4) for subscription (UUID: 720d4df4-7469-47f2-9e42-a6a5152761bf).' + message: "Deleted ACL rule (UUID: 93136254-7d65-465c-82e9-5e92d74ae6b4) for subscription (UUID: 720d4df4-7469-47f2-9e42-a6a5152761bf)." _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/93136254-7d65-465c-82e9-5e92d74ae6b4' + href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl/93136254-7d65-465c-82e9-5e92d74ae6b4 parent: - href: 'https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl' + href: https://cloud.acquia.com/api/subscriptions/720d4df4-7469-47f2-9e42-a6a5152761bf/shield-acl notification: - href: 'https://cloud.acquia.com/api/notifications/98c1c68d-d33d-4340-8cd2-f32bdbf035f3' - '400': + href: https://cloud.acquia.com/api/notifications/98c1c68d-d33d-4340-8cd2-f32bdbf035f3 + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Acquia Shield not available: value: @@ -27512,113 +29065,113 @@ paths: error: validation_failed message: general: The Shield ACL Rule with UUID 638c13e7-0455-45de-ab63-def9d348d50f does not belong to the subscription with UUID e3959c8a-f53d-49a1-adb7-acdc8e717940. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: unauthorized message: You do not have permission to delete a Shield ACL rule. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' + message: The subscription you are trying to access does not exist, or you do not have permission to access it. No subscription: value: error: not_found message: The subscription with UUID 720d4df4-7469-47f2-9e42-a6a5152761bf does not exist. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Shield ACL updates in progress: value: error: conflict message: general: Shield ACL rules cannot be deleted while ACL rule updates are in progress. - '/subscriptions/{subscriptionUuid}/shield-acl/actions/reset': + "/subscriptions/{subscriptionUuid}/shield-acl/actions/reset": post: tags: - Subscriptions summary: Resets Shield ACL rules to default settings. operationId: postResetShieldAcl - x-cli-name: 'subscriptions:shield-acl-reset' + x-cli-name: subscriptions:shield-acl-reset parameters: - - $ref: '#/components/parameters/SubscriptionUuid' + - $ref: "#/components/parameters/SubscriptionUuid" responses: - '202': + "202": description: Accepted content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/MessageWithLinks' + $ref: "#/components/schemas/MessageWithLinks" example: message: Shield ACL rules reset for subscription with UUID 94afc849-3b5a-49cd-bcae-464333994019. _links: self: - href: 'https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl' + href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019/shield-acl parent: - href: 'https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019' + href: https://cloud.acquia.com/api/subscriptions/94afc849-3b5a-49cd-bcae-464333994019 notification: - href: 'https://cloud.acquia.com/api/notifications/a894467e-8ea2-4b0d-9b03-27909098ee3a' - '400': + href: https://cloud.acquia.com/api/notifications/a894467e-8ea2-4b0d-9b03-27909098ee3a + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Acquia Shield not available: value: error: validation_failed message: general: Shield rules can only be reset on subscriptions that have Acquia Shield. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to reset Shield ACL rules. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No subscription or permission: value: error: not_found - message: 'The subscription you are trying to access does not exist, or you do not have permission to access it.' + message: The subscription you are trying to access does not exist, or you do not have permission to access it. No subscription: value: error: not_found message: A subscription with UUID 720d4df4-7469-47f2-9e42-a6a5152761bf cannot be found. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Shield ACL updates in progress: value: @@ -27639,27 +29192,27 @@ paths: Sortable fields: * `name` operationId: getTeams - x-cli-name: 'tps:teams-list' + x-cli-name: tps:teams-list parameters: - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Range' + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Range" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Teams' + $ref: "#/components/schemas/Teams" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/teams' + href: https://cloud.acquia.com/api/teams _embedded: items: - uuid: abcd1234-82b5-11e3-9170-12313920a02c @@ -27671,7 +29224,7 @@ paths: name: Sample Organization _links: self: - href: 'https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c' + href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c - uuid: 1234abcd-82b5-11e3-9170-12313920a02c name: Team Name 2 created_at: '2014-05-27T11:55:39-0700' @@ -27681,37 +29234,37 @@ paths: name: Sample Organization _links: self: - href: 'https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f' - '403': + href: https://cloud.acquia.com/api/teams/9ca6ecc0-e5d0-11e3-9eb3-22000b04072f + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to view teams. - '/teams/{teamUuid}': + "/teams/{teamUuid}": get: tags: - Teams and Permissions summary: Return details about a specific team. description: Return details about a specific team. operationId: getTeam - x-cli-name: 'tps:team-find' + x-cli-name: tps:team-find parameters: - - $ref: '#/components/parameters/TeamUuid' + - $ref: "#/components/parameters/TeamUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Team' + $ref: "#/components/schemas/Team" example: uuid: 2c9ea556-4016-11e3-9170-12313920a02c name: Sample Team @@ -27722,48 +29275,48 @@ paths: name: Sample Organization _links: self: - href: 'https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c' + href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c members: - href: 'https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/members' + href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/members applications: - href: 'https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/applications' + href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/applications invites: - href: 'https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/invites' + href: https://cloud.acquia.com/api/teams/2c9ea556-4016-11e3-9170-12313920a02c/invites parent: - href: 'https://cloud.acquia.com/api/teams' + href: https://cloud.acquia.com/api/teams _embedded: organization: - uuid: 2375e327-3fff-11e3-9170-12313920a02c name: Sample Organization _links: self: - href: 'https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c' - '404': + href: https://cloud.acquia.com/api/organizations/2375e327-3fff-11e3-9170-12313920a02c + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Role not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. put: tags: - Teams and Permissions summary: Change the name of a team. description: Change the name of a team. operationId: putTeamsName - x-cli-name: 'tps:team-update' + x-cli-name: tps:team-update security: - OAuth2: [] parameters: - - $ref: '#/components/parameters/TeamUuid' + - $ref: "#/components/parameters/TeamUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object properties: @@ -27786,94 +29339,94 @@ paths: example: name: My new team name responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Team renamed: value: message: Team renamed. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Role not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to rename it.' + message: The team you are trying to access does not exist, or you do not have permission to rename it. delete: tags: - Teams and Permissions summary: Deletes a specific team by its UUID. description: Deletes a specific team by its UUID. operationId: deleteTeam - x-cli-name: 'tps:team-delete' + x-cli-name: tps:team-delete parameters: - - $ref: '#/components/parameters/TeamUuid' + - $ref: "#/components/parameters/TeamUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Removed team: value: message: Removed team. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Team not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to remove it.' - '/teams/{teamUuid}/actions/leave': + message: The team you are trying to access does not exist, or you do not have permission to remove it. + "/teams/{teamUuid}/actions/leave": post: tags: - Teams and Permissions summary: Removes the current user from a team. description: Removes the current user from a team. operationId: postLeaveTeam - x-cli-name: 'tps:user-leave' + x-cli-name: tps:user-leave parameters: - - $ref: '#/components/parameters/TeamUuid' + - $ref: "#/components/parameters/TeamUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Left team: value: message: You have left the team. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. Invalid team: value: error: not_found @@ -27886,7 +29439,7 @@ paths: value: error: not_found message: The user is not a member of this team. - '/teams/{teamUuid}/applications': + "/teams/{teamUuid}/applications": get: tags: - Teams and Permissions @@ -27900,20 +29453,20 @@ paths: Sortable fields: * `name` operationId: getTeamApplications - x-cli-name: 'tps:team-application-list' + x-cli-name: tps:team-application-list parameters: - - $ref: '#/components/parameters/TeamUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/TeamUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Applications' + $ref: "#/components/schemas/TeamApplications" example: total: 2 pagination: @@ -27922,18 +29475,18 @@ paths: offset: 0 _links: self: - href: 'https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications' + href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications sort: - href: 'https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?sort}' + href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?filter}' + href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?limit}' + href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5/applications{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5' + href: https://cloud.acquia.com/api/teams/f6c5006c-f670-4778-9ae5-49018475ece5 _embedded: items: - id: 241643 @@ -27941,7 +29494,7 @@ paths: name: Sample application 1 hosting: type: acp - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: fc04cc3e-8d91-4fb4-a8dd-15dc81df7458 name: Sample subscription @@ -27951,15 +29504,16 @@ paths: flags: remote_admin: true status: normal + type: drupal _links: self: - href: 'https://cloud.acquia.com/api/applications/50cf9819-6f99-4ef2-be10-1a85dc354ca1' + href: https://cloud.acquia.com/api/applications/50cf9819-6f99-4ef2-be10-1a85dc354ca1 - id: 954291 uuid: a47ac10b-58cc-4372-a567-0e02b2c3d471 name: Sample application 2 hosting: type: free - id: 'devcloud:devcloud2' + id: devcloud:devcloud2 subscription: uuid: fc04cc3e-8d91-4fb4-a8dd-15dc81df7458 name: Sample subscription @@ -27969,33 +29523,34 @@ paths: flags: remote_admin: false status: provisioning + type: drupal _links: self: - href: 'https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d471' - '404': + href: https://cloud.acquia.com/api/teams/a47ac10b-58cc-4372-a567-0e02b2c3d471/applications + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. post: tags: - Teams and Permissions summary: Adds an application to this team. description: Adds an application to this team. operationId: postTeamAddApplication - x-cli-name: 'tps:team-application-add' + x-cli-name: tps:team-application-add parameters: - - $ref: '#/components/parameters/TeamUuid' + - $ref: "#/components/parameters/TeamUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -28026,104 +29581,104 @@ paths: security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Added application: value: message: Added application to team. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: forbidden - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '404': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. Application mismatch: value: error: not_found message: The application must belong to the same organization as this team. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Application already on team: value: error: conflict message: The application is already on this team. - '/teams/{teamUuid}/applications/{applicationUuid}': + "/teams/{teamUuid}/applications/{applicationUuid}": delete: tags: - Teams and Permissions summary: Removes the application from this team. description: Removes the application from this team. Team members will immediately lose access to this application. operationId: deleteTeamsRemoveApplication - x-cli-name: 'tps:team-application-remove' + x-cli-name: tps:team-application-remove parameters: - - $ref: '#/components/parameters/TeamUuid' - - $ref: '#/components/parameters/ApplicationUuid' + - $ref: "#/components/parameters/TeamUuid" + - $ref: "#/components/parameters/ApplicationUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Removed application: value: message: Removed application from team. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: forbidden - message: 'The application you are trying to access does not exist, or you do not have permission to access it.' - '404': + message: The application you are trying to access does not exist, or you do not have permission to access it. + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Team not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. Application mismatch: value: error: not_found message: The application is not associated with this team. - '/teams/{teamUuid}/invites': + "/teams/{teamUuid}/invites": get: tags: - Teams and Permissions @@ -28141,37 +29696,37 @@ paths: * `token` * `author` operationId: getTeamInvites - x-cli-name: 'tps:team-invite-list' + x-cli-name: tps:team-invite-list parameters: - - $ref: '#/components/parameters/TeamUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Range' + - $ref: "#/components/parameters/TeamUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Range" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/TeamInvites' + $ref: "#/components/schemas/TeamInvites" example: total: 2 _links: self: - href: 'https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites' + href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites sort: - href: 'https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?sort}' + href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?sort} templated: true filter: - href: 'https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?filter}' + href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?filter} templated: true limit: - href: 'https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?limit}' + href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625/invites{?limit} templated: true parent: - href: 'https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625' + href: https://cloud.acquia.com/api/teams/06adb604-d918-49f0-8ad6-06f037a4c625 _embedded: items: - applications: @@ -28183,7 +29738,7 @@ paths: 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' + picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=jane.doe@example.com roles: - uuid: aba649d1-795e-4472-87c8-7b32536c71b3 name: Senior Developer @@ -28203,7 +29758,7 @@ paths: declined: true _links: self: - href: 'https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ec' + href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ec - applications: - uuid: 88dc87db-1169-4908-9384-2328a7bd5cc1 name: Main Application @@ -28215,7 +29770,7 @@ paths: 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' + picture_url: https://accounts.acquia.com/sites/default/files/avatars/123abc?mail=john.doe@example.com roles: - uuid: aba649d1-795e-4472-87c8-7b32536c71b3 name: Senior Developer @@ -28233,44 +29788,44 @@ paths: declined: false _links: self: - href: 'https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed' - '403': + href: https://cloud.acquia.com/api/invites/dd9ea69fdcb6bee08b31a858b85535ed + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to view invites for this team. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. post: tags: - Teams and Permissions summary: Invites a user to join a team. description: Invites a user to join a team. operationId: postTeamsInviteUser - x-cli-name: 'tps:team-user-invite' + x-cli-name: tps:team-user-invite parameters: - - $ref: '#/components/parameters/TeamUuid' + - $ref: "#/components/parameters/TeamUuid" requestBody: required: true content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/PostInvite' + $ref: "#/components/schemas/PostInvite" example: email: person@example.com roles: @@ -28278,82 +29833,82 @@ paths: - 8025e9a7-781a-4ad1-b7ea-1f1b732944c2 application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/PostInvite' + $ref: "#/components/schemas/PostInvite" example: - $ref: '#/paths/~1teams~1%7BteamUuid%7D~1invites/post/requestBody/content/application~1json/example' + $ref: "#/paths/~1teams~1%7BteamUuid%7D~1invites/post/requestBody/content/application~1hal%2Bjson/example" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Invited: value: message: Invited team member. - '201': + "201": description: Created content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Invite' - '400': + $ref: "#/components/schemas/Invite" + "400": description: Bad Request content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" examples: Missing parameter: value: error: validation_failed message: - name: 'Missing required parameter(s): example_param' + name: "Missing required parameter(s): example_param" Invalid parameter: value: error: validation_failed message: - name: 'Invalid values for parameter(s): example_param' - '403': + name: "Invalid values for parameter(s): example_param" + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Insufficient permissions: value: error: forbidden message: You do not have permission to invite users to this team. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Team not found: value: error: not_found - message: 'The team you are trying to modify does not exist, or you do not have permission to access it.' + message: The team you are trying to modify does not exist, or you do not have permission to access it. Role not found: value: error: not_found message: One or more of the chosen roles do not belong to this organization. - '409': + "409": description: Conflict content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Invitation already sent: value: error: conflict - message: 'An invitation to person@example.com has already been sent. It was sent on May 6, 2016 - 7:26pm.' + message: An invitation to person@example.com has already been sent. It was sent on May 6, 2016 - 7:26pm. User already on team: value: error: conflict @@ -28362,7 +29917,7 @@ paths: value: error: conflict message: A team member must be invited with at least one role. - '/teams/{teamUuid}/members': + "/teams/{teamUuid}/members": get: tags: - Teams and Permissions @@ -28381,27 +29936,27 @@ paths: * `first_name` * `last_name` operationId: getTeamMembers - x-cli-name: 'tps:team-member-list' + x-cli-name: tps:team-member-list parameters: - - $ref: '#/components/parameters/TeamUuid' - - $ref: '#/components/parameters/Sort' - - $ref: '#/components/parameters/Filter' - - $ref: '#/components/parameters/Limit' - - $ref: '#/components/parameters/Offset' + - $ref: "#/components/parameters/TeamUuid" + - $ref: "#/components/parameters/Sort" + - $ref: "#/components/parameters/Filter" + - $ref: "#/components/parameters/Limit" + - $ref: "#/components/parameters/Offset" responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/TeamMembers' + $ref: "#/components/schemas/TeamMembers" example: total: 3 _links: self: - href: 'https://cloud.acquia.com/api/teams/3c9ea553-3216-11e3-9170-12313920a23a/members' + href: https://cloud.acquia.com/api/teams/3c9ea553-3216-11e3-9170-12313920a23a/members parent: - href: 'https://cloud.acquia.com/api/teams/3c9ea553-3216-11e3-9170-12313920a23a' + href: https://cloud.acquia.com/api/teams/3c9ea553-3216-11e3-9170-12313920a23a _embedded: items: - uuid: 5aa902c5-f1c1-6c94-edfa-86bc58d0dce3 @@ -28409,7 +29964,7 @@ paths: last_name: Kirk last_login_at: '2017-03-28T13:07:54-0500' mail: james.kirk@example.com - picture_url: 'https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar' + picture_url: https://accounts.acquia.com/images/users/5aa902c5-f1c1-6c94-edfa-86bc58d0dce3/style/avatar username: james.kirk roles: - uuid: 2d988ad3-4016-11e3-9170-12313920a02e @@ -28417,9 +29972,9 @@ paths: - uuid: 30dacb5e-4122-11e1-9eb5-12313928d3c2 first_name: Christopher last_name: Pike - last_login_at: '2016-03-28T13:07:54-0500' + last_login_at: 2016-03-28T13:07:54-0500 mail: chris.pike@example.com - picture_url: 'https://accounts.acquia.com/images/users/30dacb5e-4122-11e1-9eb5-12313928d3c2/style/avatar' + picture_url: https://accounts.acquia.com/images/users/30dacb5e-4122-11e1-9eb5-12313928d3c2/style/avatar username: chris.pike roles: - uuid: 3c9a1174-4016-11e3-9170-12313920a02d @@ -28429,41 +29984,41 @@ paths: last_name: Archer last_login_at: null mail: jonathan.archer@example.com - picture_url: 'https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar' + picture_url: https://accounts.acquia.com/images/users/3bcddc3a-52ba-4cce-aaa3-9adf721c1b52/style/avatar username: jonathan.archer roles: - uuid: 2d988ad3-4016-11e3-9170-12313920a02e name: Senior Developer - uuid: 3c9a1174-4016-11e3-9170-12313920a02d name: Developer - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' - '/teams/{teamUuid}/members/{userUuid}': + message: The team you are trying to access does not exist, or you do not have permission to access it. + "/teams/{teamUuid}/members/{userUuid}": put: tags: - Teams and Permissions summary: Grant team roles to a member. description: Grant team roles to a member. operationId: putTeamsMember - x-cli-name: 'tps:team-member-add' + x-cli-name: tps:team-member-add parameters: - - $ref: '#/components/parameters/TeamUuid' - - $ref: '#/components/parameters/UserUuid' + - $ref: "#/components/parameters/TeamUuid" + - $ref: "#/components/parameters/UserUuid" security: - OAuth2: [] requestBody: required: true content: - application/json: + application/hal+json: schema: type: object required: @@ -28500,83 +30055,83 @@ paths: - 489efe35-7bb7-48b7-9aa2-f6f8f457c926 - 8025e9a7-781a-4ad1-b7ea-1f1b732944c2 responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Modified member roles: value: message: Modified member roles. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to modify team member roles. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team you are trying to access does not exist, or you do not have permission to access it.' + message: The team you are trying to access does not exist, or you do not have permission to access it. delete: tags: - Teams and Permissions summary: Remove a user from a team. description: Remove a user from a team. operationId: deleteTeamsRemoveMember - x-cli-name: 'tps:team-member-remove' + x-cli-name: tps:team-member-remove parameters: - - $ref: '#/components/parameters/TeamUuid' - - $ref: '#/components/parameters/UserUuid' + - $ref: "#/components/parameters/TeamUuid" + - $ref: "#/components/parameters/UserUuid" security: - OAuth2: [] responses: - '200': + "200": description: OK content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Message' + $ref: "#/components/schemas/Message" examples: Team member removed: value: message: Team member removed. - '403': + "403": description: Forbidden content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: No permission: value: error: forbidden message: You do not have permission to remove team members. - '404': + "404": description: Not Found content: - application/json: + application/hal+json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" examples: Not found: value: error: not_found - message: 'The team member you are trying to remove does not exist, or you do not have permission to remove them.' + message: The team member you are trying to remove does not exist, or you do not have permission to remove them. Invalid team: value: error: not_found diff --git a/tests/phpunit/src/Commands/Api/ApiCommandTest.php b/tests/phpunit/src/Commands/Api/ApiCommandTest.php index b518c32d0..9744a31be 100644 --- a/tests/phpunit/src/Commands/Api/ApiCommandTest.php +++ b/tests/phpunit/src/Commands/Api/ApiCommandTest.php @@ -407,7 +407,7 @@ public function providerTestApiCommandDefinitionRequestBody(): array { public function testApiCommandDefinitionRequestBody(string $commandName, string $method, string $usage): void { $this->command = $this->getApiCommandByName($commandName); $resource = $this->getResourceFromSpec($this->command->getPath(), $method); - foreach ($resource['requestBody']['content']['application/json']['example'] as $propKey => $value) { + foreach ($resource['requestBody']['content']['application/hal+json']['example'] as $propKey => $value) { $this->assertTrue($this->command->getDefinition()->hasArgument($propKey) || $this->command->getDefinition() ->hasOption($propKey), "Command {$this->command->getName()} does not have expected argument or option $propKey"); diff --git a/tests/phpunit/src/TestBase.php b/tests/phpunit/src/TestBase.php index 4764f606e..9d32dd2b4 100644 --- a/tests/phpunit/src/TestBase.php +++ b/tests/phpunit/src/TestBase.php @@ -272,7 +272,12 @@ protected function getResourceFromSpec(mixed $path, mixed $method): mixed { public function getMockResponseFromSpec(mixed $path, mixed $method, mixed $httpCode): object { $endpoint = $this->getResourceFromSpec($path, $method); $response = $endpoint['responses'][$httpCode]; - $content = $response['content']['application/json']; + if (array_key_exists('application/hal+json', $response['content'])) { + $content = $response['content']['application/hal+json']; + } + else { + $content = $response['content']['application/json']; + } if (array_key_exists('example', $content)) { $responseBody = json_encode($content['example'], JSON_THROW_ON_ERROR); @@ -336,9 +341,13 @@ protected function injectCommand(string $commandName): Command { ); } - public function getMockRequestBodyFromSpec(mixed $path, string $method = 'post'): mixed { + public function getMockRequestBodyFromSpec(string $path, string $method = 'post'): mixed { $endpoint = $this->getResourceFromSpec($path, $method); - return $endpoint['requestBody']['content']['application/json']['example']; + if (array_key_exists('application/json', $endpoint['requestBody']['content'])) { + return $endpoint['requestBody']['content']['application/json']['example']; + } + + return $endpoint['requestBody']['content']['application/hal+json']['example']; } protected function getCloudApiSpec(): mixed {