diff --git a/assets/acquia-spec.json b/assets/acquia-spec.json index ff81ebda9..355f2fdc4 100644 --- a/assets/acquia-spec.json +++ b/assets/acquia-spec.json @@ -7,7 +7,7 @@ "backgroundColor": "#FFFFFF", "altText": "Acquia Cloud" }, - "description": "Acquia Cloud API\n\n# Compatibility\n\n## Stability\n\nThe response for all resource endpoints includes an `X-CloudAPI-Stability` header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.\n\nThere are three levels of stability:\n\n* `prototype`: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one week notice\n * Deprecated resources will remain available for at least one month after deprecation\n* `development`: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one month notice\n * Deprecated resources will remain available for at least six months after deprecation\n* `production`: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.\n\n## Deprecation\n\nOver time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an `X-CloudAPI-Deprecated` header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.\n\n## Versioning\n\nAll resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.\n\nA specific version of an endpoint can be requested via the `Accept` header:\n\n Accept: application/hal+json, version=2\n\nIf the version is not specified, the latest version of the endpoint will be used.\n\nStarting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is [provided elsewhere](https://cloudapi.acquia.com/).\n\n## Errors\n\nSome endpoints will return a 503 status when dependent services are unavailable:\n\n application/hal+json\n {\n \"error\": \"system\",\n \"message\": \"This action is currently unavailable. Please try again later.\"\n }\n\n## Authentication\n\nAll Acquia Cloud API calls require authentication to work properly.\n\nLearn more: https://docs.acquia.com/acquia-cloud/develop/api/auth/\n\n### Example implementation\n\nAn example PHP script for making authenticated API requests can be found here. This script uses the League/oauth2-client library, installed via Composer.\n", + "description": "Acquia Cloud API\n\n# Compatibility\n\n## Stability\n\nThe response for all resource endpoints includes an `X-CloudAPI-Stability` header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.\n\nThere are three levels of stability:\n\n* `prototype`: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one week notice\n * Deprecated resources will remain available for at least one month after deprecation\n* `development`: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one month notice\n * Deprecated resources will remain available for at least six months after deprecation\n* `production`: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.\n\n## Deprecation\n\nOver time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an `X-CloudAPI-Deprecated` header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.\n\n## Versioning\n\nAll resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.\n\nA specific version of an endpoint can be requested via the `Accept` header:\n\n Accept: application/hal+json, version=2\n\nIf the version is not specified, the latest version of the endpoint will be used.\n\nStarting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is [provided elsewhere](https://cloudapi.acquia.com/).\n\n## Errors\n\nSome endpoints will return a 503 status when dependent services are unavailable:\n\n application/hal+json\n {\n \"error\": \"system\",\n \"message\": \"This action is currently unavailable. Please try again later.\"\n }\n\n## Authentication\n\nAll Acquia Cloud API calls require authentication to work properly.\n\nLearn more: https://docs.acquia.com/acquia-cloud/develop/api/auth/\n\n### Example implementation\n\nAn example PHP script for making authenticated API requests can be found here. This script uses the League/oauth2-client library, installed via Composer.\n", "version": "2.0.0", "contact": { "name": "Customer Experience Engineering (CXE)", @@ -105,6 +105,12 @@ ], "paths": { "/": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Current system health" @@ -162,6 +168,12 @@ } }, "/account": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -185,7 +197,7 @@ "first_name": "Jane", "last_name": "Doe", "last_login_at": "2017-03-28T13:07:54-0500", - "created_at": "2016-07-17T20:35:25.000Z", + "created_at": "2016-07-17T20:35:25+00:00", "mail": "jane.doe@example.com", "phone": { "office": null, @@ -273,6 +285,12 @@ } }, "/account/applications/{applicationUuid}/has-permission": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -362,6 +380,12 @@ } }, "/account/applications/{applicationUuid}/is-admin": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -442,6 +466,12 @@ } }, "/account/applications/{applicationUuid}/is-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -504,6 +534,12 @@ } }, "/account/applications/{applicationUuid}/actions/mark-recent": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Account" @@ -580,6 +616,12 @@ } }, "/account/applications/{applicationUuid}/actions/star": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Account" @@ -662,6 +704,12 @@ } }, "/account/applications/{applicationUuid}/actions/unstar": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Account" @@ -744,6 +792,12 @@ } }, "/account/drush-aliases/download": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -826,6 +880,12 @@ } }, "/account/ides": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -920,6 +980,12 @@ } }, "/account/invites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1075,6 +1141,12 @@ } }, "/account/messages": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1166,8 +1238,8 @@ "active": true }, "weight": -1, - "start_at": "2019-07-07T13:45:00.000Z", - "expire_at": "2019-07-15T13:45:00.000Z", + "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" @@ -1197,8 +1269,8 @@ "active": true }, "weight": -1, - "start_at": "2019-07-07T13:45:00.000Z", - "expire_at": "2019-07-15T13:45:00.000Z", + "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" @@ -1239,6 +1311,12 @@ } }, "/account/organizations/{organizationUuid}/is-admin": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1319,6 +1397,12 @@ } }, "/account/organizations/{organizationUuid}/is-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1381,6 +1465,12 @@ } }, "/account/password": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Account" @@ -1433,6 +1523,12 @@ } }, "/account/ssh-keys": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1711,6 +1807,12 @@ } }, "/account/ssh-keys/{sshKeyUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1856,6 +1958,12 @@ } }, "/account/subscriptions/{subscriptionUuid}/is-admin": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1936,6 +2044,12 @@ } }, "/account/subscriptions/{subscriptionUuid}/is-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1998,6 +2112,12 @@ } }, "/account/teams/{teamUuid}/has-permission": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2087,6 +2207,12 @@ } }, "/account/teams/{teamUuid}/is-admin": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2167,6 +2293,12 @@ } }, "/account/teams/{teamUuid}/is-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2229,6 +2361,12 @@ } }, "/account/tokens": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2402,6 +2540,12 @@ } }, "/account/tokens/{tokenUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2555,6 +2699,12 @@ } }, "/agreements": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Agreements" @@ -2589,8 +2739,8 @@ "title": "Agreement Title", "body": "

Agreement body and text.

", "status": "accepted", - "created_at": "2017-01-23T12:00:00.000Z", - "updated_at": "2017-01-27T12:00:00.000Z", + "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", @@ -2616,8 +2766,8 @@ "title": "Another Agreement", "body": "

This is the body and text of another agreement.

", "status": "declined", - "created_at": "2017-02-23T12:00:00.000Z", - "updated_at": "2017-02-27T12:00:00.000Z", + "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", @@ -2643,7 +2793,7 @@ "title": "A Third Agreement", "body": "

This is the body and text of one more agreement.

", "status": "pending", - "created_at": "2017-02-23T12:00:00.000Z", + "created_at": "2017-02-23T12:00:00Z", "updated_at": null, "actioned_by": null, "reference": { @@ -2681,6 +2831,12 @@ } }, "/agreements/{agreementUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Agreements" @@ -2713,8 +2869,8 @@ "title": "Agreement Title", "body": "

Agreement body and text.

", "status": "accepted", - "created_at": "2017-01-23T12:00:00.000Z", - "updated_at": "2017-01-27T12:00:00.000Z", + "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", @@ -2767,6 +2923,12 @@ } }, "/agreements/{agreementUuid}/actions/accept": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Agreements" @@ -2835,6 +2997,12 @@ } }, "/agreements/{agreementUuid}/actions/decline": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Agreements" @@ -2903,6 +3071,12 @@ } }, "/agreements/{agreementUuid}/invitees": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Agreements" @@ -2981,6 +3155,12 @@ } }, "/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3179,6 +3359,12 @@ } }, "/applications/{applicationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3491,6 +3677,12 @@ } }, "/applications/{applicationUuid}/artifacts": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3620,6 +3812,12 @@ } }, "/applications/{applicationUuid}/artifacts/{artifactId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3701,6 +3899,12 @@ } }, "/applications/{applicationUuid}/code": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3797,6 +4001,12 @@ } }, "/applications/{applicationUuid}/code-studio": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -4060,6 +4270,12 @@ } }, "/applications/{applicationUuid}/databases": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -4375,6 +4591,12 @@ } }, "/applications/{applicationUuid}/databases/{name}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "delete": { "tags": [ "Applications" @@ -4523,6 +4745,12 @@ } }, "/applications/{applicationUuid}/databases/{name}/actions/erase": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Applications" @@ -4669,6 +4897,12 @@ } }, "/applications/{applicationUuid}/email/domains": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -4805,6 +5039,12 @@ } }, "/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Applications" @@ -4925,6 +5165,12 @@ } }, "/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Applications" @@ -5051,6 +5297,12 @@ } }, "/applications/{applicationUuid}/ides": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -5107,8 +5359,8 @@ "uuid": "10be1d3e-f2b4-4d34-855d-321df3938ffd", "first_name": "First", "last_name": "Last", - "last_login_at": "2019-01-31T15:53:11.000Z", - "created_at": "2016-08-14T21:38:59.000Z", + "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", "username": "user.name" @@ -5138,8 +5390,8 @@ "uuid": "10be1d3e-f2b4-4d34-855d-321df3938ffd", "first_name": "First", "last_name": "Last", - "last_login_at": "2019-01-31T15:53:11.000Z", - "created_at": "2016-08-14T21:38:59.000Z", + "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", "username": "user.name" @@ -5304,6 +5556,12 @@ } }, "/applications/{applicationUuid}/messages": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -5384,8 +5642,8 @@ "active": true }, "weight": -1, - "start_at": "2015-11-05T05:30:00.000Z", - "expire_at": "2015-12-05T18:30:00.000Z", + "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" @@ -5415,8 +5673,8 @@ "active": true }, "weight": 0, - "start_at": "2015-11-07T22:30:00.000Z", - "expire_at": "2016-11-07T22:30:00.000Z", + "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" @@ -5457,6 +5715,12 @@ } }, "/applications/{applicationUuid}/notifications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -5528,8 +5792,8 @@ "event": "ApplicationAddedToRecents", "label": "Application added to recents list", "description": "\"Canary QA 11 - ACE\" was added to your recent applications list.", - "created_at": "2019-07-29T20:47:13.000Z", - "completed_at": "2019-07-29T20:47:13.000Z", + "created_at": "2019-07-29T20:47:13+00:00", + "completed_at": "2019-07-29T20:47:13+00:00", "status": "completed", "progress": 100, "context": { @@ -5585,6 +5849,12 @@ } }, "/applications/{applicationUuid}/permissions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6081,6 +6351,12 @@ } }, "/applications/{applicationUuid}/search": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6163,6 +6439,12 @@ } }, "/applications/{applicationUuid}/search/config-sets": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6472,6 +6754,12 @@ } }, "/applications/{applicationUuid}/search/config-sets/{configurationSetId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6677,6 +6965,12 @@ } }, "/applications/{applicationUuid}/settings": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6750,6 +7044,12 @@ } }, "/applications/{applicationUuid}/settings/hosting": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6833,6 +7133,12 @@ } }, "/applications/{applicationUuid}/settings/keys": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6921,6 +7227,12 @@ } }, "/applications/{applicationUuid}/settings/ra": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -7040,8 +7352,8 @@ "example": { "update_mode": "update", "update_type": "core_contrib", - "pause_until": "2021-10-10T13:00:00.000Z", - "deploy_at": "2020-10-13T13:00:00.000Z", + "pause_until": "2021-10-10 13:00:00", + "deploy_at": "2020-10-13 13:00:00", "deploy_environment": "test", "source_environment": "prod", "copy_files": false, @@ -7057,8 +7369,8 @@ "example": { "update_mode": "update", "update_type": "core_contrib", - "pause_until": "2021-10-10T13:00:00.000Z", - "deploy_at": "2020-10-13T13:00:00.000Z", + "pause_until": "2021-10-10 13:00:00", + "deploy_at": "2020-10-13 13:00:00", "deploy_environment": "test", "source_environment": "prod", "copy_files": false, @@ -7224,6 +7536,12 @@ } }, "/applications/{applicationUuid}/settings/security": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -7476,6 +7794,12 @@ } }, "/applications/{applicationUuid}/tags": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -7702,6 +8026,12 @@ } }, "/applications/{applicationUuid}/tags/{tagName}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "delete": { "tags": [ "Applications" @@ -7770,6 +8100,12 @@ } }, "/applications/{applicationUuid}/tasks": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -7833,8 +8169,8 @@ "uuid": "d15b1bfe-1bf3-47d4-8f3a-fd29a5daea7a", "first_name": "Example", "last_name": "User", - "last_login_at": "2019-05-23T20:12:12.000Z", - "created_at": "2015-08-14T21:37:21.000Z", + "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", "username": "example.user" @@ -7844,9 +8180,9 @@ "name": "ApplicationAddedToTeam", "title": "Application added to team.", "description": "Application Example Application has been added to team Example Team", - "created_at": "2019-04-16T17:24:55.000Z", - "started_at": "2019-04-16T17:24:55.000Z", - "completed_at": "2019-04-16T17:24:55.000Z", + "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": { @@ -7897,8 +8233,8 @@ "uuid": "66597696-118c-4e18-b7e8-d027df8d5faa", "first_name": "Example", "last_name": "User", - "last_login_at": "2019-05-30T22:08:36.000Z", - "created_at": "2015-08-13T23:37:00.000Z", + "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", "username": "example.user.2" @@ -7908,9 +8244,9 @@ "name": "FilesCopied", "title": "Files copied", "description": "Files copied from "prod" to "dev".", - "created_at": "2019-01-25T09:24:32.000Z", - "started_at": "2019-01-25T09:24:32.000Z", - "completed_at": "2019-01-25T09:24:46.000Z", + "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": { @@ -7992,6 +8328,12 @@ } }, "/applications/{applicationUuid}/teams": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8101,6 +8443,12 @@ } }, "/applications/{applicationUuid}/metrics/usage": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8198,6 +8546,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/data": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8250,15 +8604,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -8291,15 +8645,15 @@ "metric": "visits", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "3" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -8374,6 +8728,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/data-by-environment": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8499,15 +8859,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -8538,15 +8898,15 @@ "metric": "visits", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "3" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -8679,6 +9039,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/{usageMetric}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8715,15 +9081,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -8795,6 +9161,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/views-by-environment": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8890,15 +9262,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -9001,6 +9373,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/visits-by-environment": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -9096,15 +9474,15 @@ "metric": "visits", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "3" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -9207,6 +9585,12 @@ } }, "/distributions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Distributions" @@ -9300,6 +9684,12 @@ } }, "/distributions/{name}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Distributions" @@ -9387,6 +9777,12 @@ } }, "/applications/{applicationUuid}/environments": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -9904,6 +10300,12 @@ } }, "/applications/{applicationUuid}/features": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -9962,6 +10364,12 @@ } }, "/environments/{environmentId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -10573,6 +10981,12 @@ } }, "/environments/{environmentId}/actions/clear-caches": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -10697,6 +11111,12 @@ } }, "/environments/{environmentId}/actions/change-label": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -10847,6 +11267,12 @@ } }, "/environments/{environmentId}/artifacts/actions/switch": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -11026,6 +11452,12 @@ } }, "/environments/{environmentId}/operating-systems": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -11096,6 +11528,12 @@ } }, "/environments/{environmentId}/available-runtimes": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -11169,6 +11607,12 @@ } }, "/environments/{environmentId}/cdn": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -11441,6 +11885,12 @@ } }, "/environments/{environmentId}/cloud-actions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -11702,6 +12152,12 @@ } }, "/environments/{environmentId}/cloud-actions/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -11786,6 +12242,12 @@ } }, "/environments/{environmentId}/cloud-actions/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -11870,6 +12332,12 @@ } }, "/environments/{environmentId}/cloud-actions/actions/reset": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -11954,6 +12422,12 @@ } }, "/environments/{environmentId}/code": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -12124,6 +12598,12 @@ } }, "/environments/{environmentId}/code/actions/switch": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -12289,6 +12769,12 @@ } }, "/environments/{environmentId}/code/actions/import": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -12458,6 +12944,12 @@ } }, "/environments/{environmentId}/crons": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -12736,6 +13228,12 @@ } }, "/environments/{environmentId}/crons/{cronId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13084,6 +13582,12 @@ } }, "/environments/{environmentId}/crons/{cronId}/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -13200,6 +13704,12 @@ } }, "/environments/{environmentId}/crons/{cronId}/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -13316,6 +13826,12 @@ } }, "/environments/{environmentId}/databases": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13663,6 +14179,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13760,6 +14282,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/php-config": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13838,6 +14366,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/backups": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13948,7 +14482,7 @@ "name": "db_name" }, "type": "daily", - "started_at": "2012-03-28T12:00:00.000Z", + "started_at": "2012-03-28T12:00:00Z", "completed_at": "2012-03-28T12:00:01.000Z", "flags": { "deleted": false @@ -13976,8 +14510,8 @@ "name": "db_name" }, "type": "daily", - "started_at": "2017-01-08T04:00:00.000Z", - "completed_at": "2017-01-08T04:00:01.000Z", + "started_at": "2017-01-08T04:00:00Z", + "completed_at": "2017-01-08T04:00:01Z", "flags": { "deleted": false }, @@ -14004,8 +14538,8 @@ "name": "db_name" }, "type": "daily", - "started_at": "2017-01-08T05:00:02.000Z", - "completed_at": "2017-01-08T05:00:03.000Z", + "started_at": "2017-01-08T05:00:02Z", + "completed_at": "2017-01-08T05:00:03Z", "flags": { "deleted": false }, @@ -14185,6 +14719,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -14432,6 +14972,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -14466,7 +15012,7 @@ }, "example": { "url": "http://example.com/backup.gz", - "expires_at": "2020-06-16T15:15:05.000Z", + "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" @@ -14545,6 +15091,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -14686,6 +15238,12 @@ } }, "/environments/{environmentId}/dns": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -14798,6 +15356,12 @@ } }, "/environments/{environmentId}/domains": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -15115,6 +15679,12 @@ } }, "/environments/{environmentId}/domains/actions/clear-varnish": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -15240,6 +15810,12 @@ } }, "/environments/{environmentId}/domains/{domain}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -15422,6 +15998,12 @@ } }, "/environments/{environmentId}/domains/{domain}/actions/clear-varnish": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -15522,6 +16104,12 @@ } }, "/environments/{environmentId}/domains/{domain}/actions/clear-caches": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -15621,6 +16209,12 @@ } }, "/environments/{environmentId}/domains/{domain}/status": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -15703,6 +16297,12 @@ } }, "/environments/{environmentId}/eips": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -15726,12 +16326,21 @@ }, "example": { "total": 1, + "count": 1, "_links": { "self": { "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" + }, + "limit": { + "href": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips{?limit}", + "templated": true + }, + "offset": { + "href": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips{?offset}", + "templated": true } }, "_embedded": { @@ -15745,6 +16354,11 @@ "active": true, "legacy": false, "deprecated": false + }, + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/eips/f668295f-cbba-472d-8b75-c76ab89e553a" + } } } ] @@ -15775,6 +16389,12 @@ } }, "/environments/{environmentId}/email": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Email" @@ -15837,6 +16457,12 @@ } }, "/environments/{environmentId}/files": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -16021,6 +16647,12 @@ } }, "/environments/{environmentId}/logs": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -16218,6 +16850,12 @@ } }, "/environments/{environmentId}/logs/{logType}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -16251,7 +16889,7 @@ "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.000Z" + "expires_at": "2019-11-30T23:21:02+00:00" } } } @@ -16347,8 +16985,8 @@ } }, "example": { - "from": "2021-01-28T22:45:21.000Z", - "to": "2021-01-29T23:55:21.000Z" + "from": "2021-01-28T22:45:21+00:00", + "to": "2021-01-29T23:55:21+00:00" } } } @@ -16478,6 +17116,12 @@ } }, "/environments/{environmentId}/logstream": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -16557,6 +17201,12 @@ } }, "/environments/{environmentId}/livedev/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -16733,6 +17383,12 @@ } }, "/environments/{environmentId}/livedev/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -16888,6 +17544,12 @@ } }, "/environments/{environmentId}/log-forwarding-destinations": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -16941,7 +17603,7 @@ "credentials": { "certificate": { "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----", - "expires_at": "2018-07-16T16:15:33.000Z" + "expires_at": "2018-07-16T16:15:33+00:00" }, "key": null, "token": "204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5" @@ -16981,7 +17643,7 @@ "credentials": { "certificate": { "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----", - "expires_at": "2018-07-16T16:15:33.000Z" + "expires_at": "2018-07-16T16:15:33+00:00" }, "key": "1d0789d519c0b943cf38f401d30ffbdcd2e0c4cfb7c32ebc0c872bce62aadd4d", "token": "204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5" @@ -17402,6 +18064,12 @@ } }, "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -17434,7 +18102,7 @@ "credentials": { "certificate": { "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----", - "expires_at": "2018-07-16T16:15:33.000Z" + "expires_at": "2018-07-16T16:15:33+00:00" }, "key": "1d0789d519c0b943cf38f401d30ffbdcd2e0c4cfb7c32ebc0c872bce62aadd4d", "token": "204d892b449026f6e4ded264c8891c400df8fc8905f07beb5f70d706f6d4d5e5" @@ -17993,6 +18661,12 @@ } }, "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -18112,6 +18786,12 @@ } }, "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -18263,6 +18943,12 @@ } }, "/environments/{environmentId}/metrics": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18345,6 +19031,12 @@ } }, "/environments/{environmentId}/metrics/stackmetrics": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18427,6 +19119,12 @@ } }, "/environments/{environmentId}/metrics/stackmetrics/data": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18490,7 +19188,7 @@ "1447876980" ] ], - "last_data_at": "2019-06-19T00:00:00.000Z", + "last_data_at": "2019-06-19T00:00:00+00:00", "metadata": { "host": "fsdb-1.prod.hosting.acquia.com" } @@ -18511,7 +19209,7 @@ "1447876980" ] ], - "last_data_at": "2019-06-19T00:00:00.000Z", + "last_data_at": "2019-06-19T00:00:00+00:00", "metadata": { "host": "fsdb-2.prod.hosting.acquia.com" } @@ -18532,7 +19230,7 @@ "1447876980" ] ], - "last_data_at": "2019-06-19T00:00:00.000Z", + "last_data_at": "2019-06-19T00:00:00+00:00", "metadata": { "host": "web-1.prod.hosting.acquia.com" } @@ -18553,7 +19251,7 @@ "1447876980" ] ], - "last_data_at": "2019-06-19T00:00:00.000Z", + "last_data_at": "2019-06-19T00:00:00+00:00", "metadata": { "host": "web-2.prod.hosting.acquia.com" } @@ -18604,6 +19302,12 @@ } }, "/environments/{environmentId}/metrics/usage": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18692,6 +19396,12 @@ } }, "/environments/{environmentId}/metrics/usage/data": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18744,15 +19454,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -18783,15 +19493,15 @@ "metric": "visits", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "3" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -18864,6 +19574,12 @@ } }, "/environments/{environmentId}/metrics/usage/{usageMetric}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18900,15 +19616,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -18984,6 +19700,12 @@ } }, "/environments/{environmentId}/mod-proxy": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -19064,6 +19786,12 @@ } }, "/environments/{environmentId}/mod-proxy/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -19159,6 +19887,12 @@ } }, "/environments/{environmentId}/mod-proxy/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -19254,6 +19988,12 @@ } }, "/environments/{environmentId}/production-mode/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -19380,6 +20120,12 @@ } }, "/environments/{environmentId}/production-mode/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -19506,6 +20252,12 @@ } }, "/environments/{environmentId}/search": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -19588,6 +20340,12 @@ } }, "/environments/{environmentId}/search/indexes": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -19925,6 +20683,12 @@ } }, "/environments/{environmentId}/search/indexes/{indexId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -20273,6 +21037,12 @@ } }, "/environments/{environmentId}/servers": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -20458,6 +21228,12 @@ } }, "/environments/{environmentId}/servers/{serverId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -20751,6 +21527,12 @@ } }, "/environments/{environmentId}/servers/{serverId}/actions/reboot": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -20902,6 +21684,12 @@ } }, "/environments/{environmentId}/servers/{serverId}/actions/relaunch": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -21053,6 +21841,12 @@ } }, "/environments/{environmentId}/servers/{serverId}/actions/suspend": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -21204,6 +21998,12 @@ } }, "/environments/{environmentId}/servers/{serverId}/actions/upgrade": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -21363,6 +22163,12 @@ } }, "/environments/{environmentId}/settings": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -21422,6 +22228,12 @@ } }, "/environments/{environmentId}/settings/apm": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Application Performance Monitoring Services" @@ -21680,6 +22492,12 @@ } }, "/environments/{environmentId}/ssl": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -21771,6 +22589,12 @@ } }, "/environments/{environmentId}/ssl/certificates": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -22087,6 +22911,12 @@ } }, "/environments/{environmentId}/ssl/certificates/{certificateId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -22292,6 +23122,12 @@ } }, "/environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -22481,6 +23317,12 @@ } }, "/environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -22620,6 +23462,12 @@ } }, "/environments/{environmentId}/ssl/csrs": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -22978,6 +23826,12 @@ } }, "/environments/{environmentId}/ssl/csrs/{certificateId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -23218,6 +24072,12 @@ } }, "/environments/{environmentId}/variables": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -23571,6 +24431,12 @@ } }, "/environments/{environmentId}/variables/{environmentVariableName}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -24003,6 +24869,12 @@ } }, "/ides/{ideUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Cloud IDE" @@ -24055,8 +24927,8 @@ "uuid": "10be1d3e-f2b4-4d34-855d-321df3938ffd", "first_name": "First", "last_name": "Last", - "last_login_at": "2019-01-31T15:53:11.000Z", - "created_at": "2016-08-14T21:38:59.000Z", + "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", "username": "user.name" @@ -24155,6 +25027,12 @@ } }, "/identity-providers": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Identity Providers" @@ -24273,6 +25151,12 @@ } }, "/identity-providers/{identityProviderUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Identity Providers" @@ -24656,6 +25540,12 @@ } }, "/identity-providers/{identityProviderUuid}/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Identity Providers" @@ -24749,6 +25639,12 @@ } }, "/identity-providers/{identityProviderUuid}/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Identity Providers" @@ -24842,6 +25738,12 @@ } }, "/invites/{token}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Invite" @@ -24883,8 +25785,8 @@ "uuid": "2429bf71-9145-4266-b532-1f4e3beaed55", "first_name": "Joe", "last_name": "Smith", - "last_login_at": "2019-01-30T13:58:07.000Z", - "created_at": "2015-08-14T21:37:23.000Z", + "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", "username": "joe.smith" @@ -24905,7 +25807,7 @@ }, "uuid": "d258dc23-90c5-447c-b550-981b469796d9", "email": "joe.smith@example.com", - "created_at": "2019-01-30T14:12:15.000Z", + "created_at": "2019-01-30T09:12:15-05:00", "token": "189d2089-c7f1-418c-a437-9676f4edb1b3", "flags": { "declined": false @@ -25033,6 +25935,12 @@ } }, "/invites/{token}/actions/accept": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Invite" @@ -25109,6 +26017,12 @@ } }, "/invites/{token}/actions/decline": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Invite" @@ -25185,6 +26099,12 @@ } }, "/invites/{token}/actions/resend": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Invite" @@ -25243,6 +26163,12 @@ } }, "/messages/{messageUuid}/actions/dismiss": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Messages" @@ -25320,6 +26246,12 @@ } }, "/messages/{messageUuid}/actions/follow": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Messages" @@ -25367,6 +26299,12 @@ } }, "/notifications/{notificationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Notifications" @@ -25398,8 +26336,8 @@ "event": "ApplicationAddedToRecents", "label": "Application added to recents list", "description": "\"Canary QA 11 - ACE\" was added to your recent applications list.", - "created_at": "2019-07-29T20:47:13.000Z", - "completed_at": "2019-07-29T20:47:13.000Z", + "created_at": "2019-07-29T20:47:13+00:00", + "completed_at": "2019-07-29T20:47:13+00:00", "status": "completed", "progress": 100, "context": { @@ -25447,6 +26385,12 @@ } }, "/options": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25487,6 +26431,12 @@ } }, "/options/cde-sizes": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25565,6 +26515,12 @@ } }, "/options/log-forwarding": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25605,6 +26561,12 @@ } }, "/options/log-forwarding/sources": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25650,6 +26612,12 @@ } }, "/options/log-forwarding/consumers": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25692,6 +26660,12 @@ } }, "/options/colors": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25776,6 +26750,12 @@ } }, "/organizations": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -25904,6 +26884,12 @@ } }, "/organizations/{organizationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -26241,6 +27227,12 @@ } }, "/organizations/{organizationUuid}/actions/change-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Organizations" @@ -26382,6 +27374,12 @@ } }, "/organizations/{organizationUuid}/actions/leave": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Organizations" @@ -26476,6 +27474,12 @@ } }, "/organizations/{organizationUuid}/admins": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -26605,6 +27609,12 @@ } }, "/organizations/{organizationUuid}/admins/{userUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -26774,6 +27784,12 @@ } }, "/organizations/{organizationUuid}/admin-invites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -27024,6 +28040,12 @@ } }, "/organizations/{organizationUuid}/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -27229,6 +28251,12 @@ } }, "/organizations/{organizationUuid}/available-tags": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -27822,6 +28850,12 @@ } }, "/organizations/{organizationUuid}/identity-provider": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -27893,6 +28927,12 @@ } }, "/organizations/{organizationUuid}/members": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28068,6 +29108,12 @@ } }, "/organizations/{organizationUuid}/members/{userUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28277,6 +29323,12 @@ } }, "/organizations/{organizationUuid}/members/{userUuid}/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28430,6 +29482,12 @@ } }, "/organizations/{organizationUuid}/notifications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28501,8 +29559,8 @@ "event": "TeamCreated", "label": "Team created", "description": "Created a new team project anomaly.", - "created_at": "2022-12-08T15:42:37.000Z", - "completed_at": "2022-12-08T15:42:37.000Z", + "created_at": "2022-12-08T15:42:37+00:00", + "completed_at": "2022-12-08T15:42:37+00:00", "status": "completed", "progress": 100, "context": { @@ -28550,8 +29608,8 @@ "uuid": "08a44409-568f-46f6-8038-4f30e19e3eb2", "first_name": "Thomas", "last_name": "Anderson", - "last_login_at": "2022-11-30T16:22:48.000Z", - "created_at": "2019-10-15T20:22:19.000Z", + "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", "username": "thomas.a.anderson@acquia.com" @@ -28586,6 +29644,12 @@ } }, "/organizations/{organizationUuid}/roles": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28671,7 +29735,7 @@ "name": "Example Organization" }, "last_edited": { - "edited_at": "2011-03-28T17:09:41.000Z", + "edited_at": "2011-03-28T13:09:41-04:00", "user": { "uuid": "aaaa1234-11e2-c374-6954-6931d150b259", "first_name": "Jane", @@ -28719,7 +29783,7 @@ "name": "Example Organization" }, "last_edited": { - "edited_at": "2011-03-28T17:09:41.000Z", + "edited_at": "2011-03-28T13:09:41-04:00", "user": { "uuid": "6661357e-f562-4b77-8de9-60b4bf83e01b", "first_name": "Acquia", @@ -28758,7 +29822,7 @@ "name": "Example Organization" }, "last_edited": { - "edited_at": "2011-03-28T17:09:41.000Z", + "edited_at": "2011-03-28T13:09:41-04:00", "user": { "uuid": "bbbb1234-11e2-c374-6954-6931d150b259", "first_name": "John", @@ -28988,6 +30052,12 @@ } }, "/organizations/{organizationUuid}/subscriptions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -29196,6 +30266,12 @@ } }, "/organizations/{organizationUuid}/team-invites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -29264,8 +30340,8 @@ "uuid": "879fc134-e8d9-49ab-a1a8-ffa33fddf8c9", "first_name": "Joe", "last_name": "Smith", - "last_login_at": "2019-01-30T13:58:07.000Z", - "created_at": "2014-08-14T21:37:23.000Z", + "last_login_at": "2019-01-30T08:58:07-05: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", "username": "joe.smith" @@ -29303,8 +30379,8 @@ "uuid": "7e181890-bfb9-40d7-874b-ec78912c7525", "first_name": "Jane", "last_name": "Smith", - "last_login_at": "2018-01-30T13:58:07.000Z", - "created_at": "2017-08-14T21:37:23.000Z", + "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", "username": "joe.smith" @@ -29346,8 +30422,8 @@ "uuid": "36dd8434-8eda-4c75-9f80-4f8a76d622b2", "first_name": "David", "last_name": "Green", - "last_login_at": "2018-03-21T13:48:07.000Z", - "created_at": "2016-03-14T21:37:23.000Z", + "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", "username": "joe.smith" @@ -29368,7 +30444,7 @@ }, "uuid": "24f7baea-5d0c-4860-8838-23130f092c48", "email": "invitee2@example.com", - "created_at": "2013-05-15T12:00:00.000Z", + "created_at": "2013-05-15T12:00:00Z", "token": "aa1ea69fdcb6bee08b31a858b85535ee", "flags": { "declined": false @@ -29407,6 +30483,12 @@ } }, "/organizations/{organizationUuid}/teams": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -29654,6 +30736,12 @@ } }, "/permissions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -30121,6 +31209,12 @@ } }, "/roles/{roleUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -30194,7 +31288,7 @@ "name": "My Organization" }, "last_edited": { - "edited_at": "2011-03-28T17:09:41.000Z", + "edited_at": "2011-03-28T13:09:41-04:00", "user": { "uuid": "590909a0-e819-43e6-a8e3-212dc3e35852", "first_name": "Jane", @@ -30413,6 +31507,12 @@ } }, "/subscriptions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -30477,8 +31577,8 @@ "id": 123, "uuid": "faa297f3-f59a-4abc-8d71-904f51bcb1c5", "name": "Acquia Cloud Free Subscription", - "start_at": "2011-03-28T00:00:00.000Z", - "expire_at": "2015-11-11T00:00:00.000Z", + "start_at": "2011-03-28T00:00:00", + "expire_at": "2015-11-11T00:00:00", "product": { "id": 1890149, "name": "Acquia Cloud Free", @@ -30520,7 +31620,7 @@ "uuid": "36496037-6eb5-482d-8549-e45e1718f2b7", "name": "My Acquia Subscription", "start_at": "2012-05-15T12:00:00.000Z", - "expire_at": "2015-05-15T12:00:00.000Z", + "expire_at": "2015-05-15T12:00:00Z", "product": { "id": 8999, "name": "Enterprise", @@ -30562,7 +31662,7 @@ "uuid": "2d92f652-882c-458a-8183-4d9cef7c2fde", "name": "My Acquia Subscription 2", "start_at": "2012-05-15T12:00:00.000Z", - "expire_at": "2015-05-15T12:00:00.000Z", + "expire_at": "2015-05-15T12:00:00Z", "product": { "id": 8999, "name": "Enterprise", @@ -30627,6 +31727,12 @@ } }, "/subscriptions/{subscriptionUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -30657,8 +31763,8 @@ "id": 329876, "uuid": "8533debb-ae4e-427b-aa34-731719b4201a", "name": "My Subscription", - "start_at": "2015-05-13T00:00:00.000Z", - "expire_at": "2018-05-12T00:00:00.000Z", + "start_at": "2015-05-13T00:00:00", + "expire_at": "2018-05-12T00:00:00", "product": { "id": 8999, "name": "Enterprise", @@ -30808,6 +31914,12 @@ } }, "/subscriptions/{subscriptionUuid}/apm": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Application Performance Monitoring Services" @@ -30902,6 +32014,12 @@ } }, "/subscriptions/{subscriptionUuid}/apm/{apmType}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Application Performance Monitoring Services" @@ -30976,6 +32094,12 @@ } }, "/subscriptions/{subscriptionUuid}/apm/{apmType}/actions/opt-in": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Application Performance Monitoring Services" @@ -31094,6 +32218,12 @@ } }, "/subscriptions/{subscriptionUuid}/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -31234,6 +32364,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -31422,6 +32558,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Subscriptions" @@ -31502,6 +32644,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -31639,6 +32787,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio/users": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -31863,6 +33017,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio/users/{userUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -32041,6 +33201,12 @@ } }, "/subscriptions/{subscriptionUuid}/domains": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -32475,6 +33641,12 @@ } }, "/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -32728,6 +33900,12 @@ } }, "/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}/actions/verify": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Subscriptions" @@ -32839,6 +34017,12 @@ } }, "/subscriptions/{subscriptionUuid}/entitlements": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -32868,7 +34052,7 @@ "offering_ids": [ "b2a188df-00b7-47bf-a664-66835cde53b0" ], - "expires_at": "2023-05-16T11:15:05.000Z", + "expires_at": "2023-05-16T11:15:05+00:00", "flags": { "trial": true }, @@ -32883,7 +34067,7 @@ "offering_ids": [ "b2a188df-00b7-47bf-a664-66835cde53b0" ], - "expires_at": "2023-05-16T11:15:05.000Z", + "expires_at": "2023-05-16T11:15:05+00:00", "flags": { "trial": true }, @@ -32894,7 +34078,7 @@ "offering_ids": [ "b2a188df-00b7-47bf-a664-66835cde53b0" ], - "expires_at": "2023-05-16T11:15:05.000Z", + "expires_at": "2023-05-16T11:15:05+00:00", "flags": { "trial": true }, @@ -32908,7 +34092,7 @@ "offering_ids": [ "b2a188df-00b7-47bf-a664-66835cde53b0" ], - "expires_at": "2023-05-16T11:15:05.000Z", + "expires_at": "2023-05-16T11:15:05+00:00", "flags": { "trial": true }, @@ -32919,7 +34103,7 @@ "offering_ids": [ "b2a188df-00b7-47bf-a664-66835cde53b0" ], - "expires_at": "2023-05-16T11:15:05.000Z", + "expires_at": "2023-05-16T11:15:05+00:00", "flags": { "trial": true }, @@ -32930,7 +34114,7 @@ "offering_ids": [ "b2a188df-00b7-47bf-a664-66835cde53b0" ], - "expires_at": "2023-05-16T11:15:05.000Z", + "expires_at": "2023-05-16T11:15:05+00:00", "flags": { "trial": true }, @@ -32975,6 +34159,12 @@ } }, "/subscriptions/{subscriptionUuid}/ides": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33031,8 +34221,8 @@ "uuid": "10be1d3e-f2b4-4d34-855d-321df3938ffd", "first_name": "First", "last_name": "Last", - "last_login_at": "2019-01-31T15:53:11.000Z", - "created_at": "2016-08-14T21:38:59.000Z", + "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", "username": "user.name" @@ -33062,8 +34252,8 @@ "uuid": "10be1d3e-f2b4-4d34-855d-321df3938ffd", "first_name": "First", "last_name": "Last", - "last_login_at": "2019-01-31T15:53:11.000Z", - "created_at": "2016-08-14T21:38:59.000Z", + "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", "username": "user.name" @@ -33098,6 +34288,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33195,6 +34391,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/data": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33247,15 +34449,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -33281,15 +34483,15 @@ "metric": "visits", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "3" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -33357,6 +34559,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/data-by-application": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33422,15 +34630,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -33463,15 +34671,15 @@ "metric": "visits", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "3" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -33546,6 +34754,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/{usageMetric}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33582,15 +34796,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -33655,6 +34869,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/views-by-application": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33720,15 +34940,15 @@ "metric": "views", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "9" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -33803,6 +35023,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/visits-by-application": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33868,15 +35094,15 @@ "metric": "visits", "datapoints": [ [ - "2019-03-13T00:00:00.000Z", + "2019-03-13T00:00:00+00:00", "3" ], [ - "2019-03-14T00:00:00.000Z", + "2019-03-14T00:00:00+00:00", "1" ] ], - "last_data_at": "2019-03-14T00:00:00.000Z", + "last_data_at": "2019-03-14T00:00:00+00:00", "metadata": { "subscription": { "uuids": [ @@ -33951,6 +35177,12 @@ } }, "/subscriptions/{subscriptionUuid}/shield-acl": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -34236,6 +35468,12 @@ } }, "/subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -34609,6 +35847,12 @@ } }, "/subscriptions/{subscriptionUuid}/shield-acl/actions/reset": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Subscriptions" @@ -34733,6 +35977,12 @@ } }, "/teams": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -34838,6 +36088,12 @@ } }, "/teams/{teamUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -35078,6 +36334,12 @@ } }, "/teams/{teamUuid}/actions/leave": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Teams and Permissions" @@ -35154,6 +36416,12 @@ } }, "/teams/{teamUuid}/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -35441,6 +36709,12 @@ } }, "/teams/{teamUuid}/applications/{applicationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "delete": { "tags": [ "Teams and Permissions" @@ -35526,6 +36800,12 @@ } }, "/teams/{teamUuid}/invites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -35901,6 +37181,12 @@ } }, "/teams/{teamUuid}/members": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -36023,6 +37309,12 @@ } }, "/teams/{teamUuid}/members/{userUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "put": { "tags": [ "Teams and Permissions" @@ -36254,6 +37546,12 @@ } }, "/codebases/{codebaseId}/bulk-code-switch": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "api_codebases_codebaseIdbulk-code-switch_get_collection", "tags": [ @@ -36342,7 +37640,7 @@ "created_at": { "type": "string", "format": "date-time", - "example": "2024-12-20T06:39:57.000Z" + "example": "2024-12-20T06:39:57+00:00" } } } @@ -36737,6 +38035,12 @@ } }, "/codebases/{codebaseId}/bulk-code-switch/{bulkCodeSwitchId}": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "get_bulk_code_switch_resource", "tags": [ @@ -36792,7 +38096,7 @@ "created_at": { "type": "string", "format": "date-time", - "example": "2024-12-20T06:39:57.000Z" + "example": "2024-12-20T06:39:57+00:00" } } } @@ -36890,6 +38194,12 @@ } }, "/applications/{applicationId}/codebase": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "api_applications_applicationIdcodebase_get", "tags": [ @@ -36994,12 +38304,12 @@ "created_at": { "type": "string", "format": "date-time", - "example": "2024-12-11T04:25:47.000Z" + "example": "2024-12-11T04:25:47+00:00" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2024-12-11T04:25:47.000Z" + "example": "2024-12-11T04:25:47+00:00" }, "description": { "type": "string", @@ -37104,6 +38414,12 @@ } }, "/codebases": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "api_codebases_get_collection", "tags": [ @@ -37241,12 +38557,12 @@ "created_at": { "type": "string", "format": "date-time", - "example": "2024-12-20T06:39:50.000Z" + "example": "2024-12-20T06:39:50+00:00" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2024-12-20T06:39:50.000Z" + "example": "2024-12-20T06:39:50+00:00" }, "description": { "type": "string", @@ -37422,6 +38738,12 @@ } }, "/codebases/{codebaseId}": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "get_codebase_by_id", "tags": [ @@ -37526,12 +38848,12 @@ "created_at": { "type": "string", "format": "date-time", - "example": "2024-12-11T04:25:47.000Z" + "example": "2024-12-11T04:25:47+00:00" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2024-12-11T04:25:47.000Z" + "example": "2024-12-11T04:25:47+00:00" }, "description": { "type": "string", @@ -37906,6 +39228,12 @@ } }, "/subscriptions/{subscriptionId}/codebases": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "operationId": "subscription_codebases", "tags": [ @@ -38545,16 +39873,21 @@ ] } }, - "/codebases/{codebaseId}/applications": { + "/codebases/{codebaseId}/references": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { - "operationId": "codebase_applications", - "x-prerelease": true, + "operationId": "get_references_by_codebase", "tags": [ "Codebases" ], "responses": { "200": { - "description": "Retrieves a list of applications by codebase ID.", + "description": "Retrieves a list of git references by codebase.", "content": { "application/hal+json": { "schema": { @@ -38596,13 +39929,23 @@ "_links": { "type": "object", "properties": { + "parent": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687" + } + } + }, "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", - "example": "https://cloud.acquia.com/api/applications/App1" + "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references" } } } @@ -38610,11 +39953,20 @@ }, "id": { "type": "string", - "example": "App1" + "example": "1234567" }, - "machine_name": { + "name": { "type": "string", - "example": "APP_NAME" + "example": "main" + }, + "type": { + "type": "string", + "example": "BRANCH" + }, + "codebase_id": { + "type": "string", + "format": "uuid", + "example": "47de85b1-14bb-4074-8c1d-f0a2d63db687" } } } @@ -38624,33 +39976,37 @@ "_links": { "type": "object", "properties": { - "parent": { + "self": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778" + "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references" } } }, - "self": { + "limit": { "type": "object", "properties": { "href": { "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778/applications" + "format": "uri-template", + "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references{?limit}" + }, + "templated": { + "type": "boolean", + "example": true } } }, - "limit": { + "offset": { "type": "object", "properties": { "href": { "type": "string", "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778/applications{?limit}" + "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references{?offset}" }, "templated": { "type": "boolean", @@ -38658,13 +40014,13 @@ } } }, - "offset": { + "filter": { "type": "object", "properties": { "href": { "type": "string", "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778/applications{?offset}" + "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references{?filter}" }, "templated": { "type": "boolean", @@ -38672,259 +40028,13 @@ } } }, - "filter": { + "sort": { "type": "object", "properties": { "href": { "type": "string", "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778/applications{?filter}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - } - } - } - } - } - } - } - }, - "403": { - "description": "Access Denied", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." - }, - "code": { - "type": "integer", - "example": 403 - } - } - } - } - } - }, - "404": { - "description": "Codebase not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The codebase you are trying to access does not exist, or you do not have permission to access it." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } - } - }, - "summary": "Retrieves a list of applications by codebase ID.", - "description": "Retrieves the collection of application resources from codebase ID. If the user has admin-level access, no filter is applied. Otherwise, the resources are filtered based on the requesting user's permissions.", - "x-cli-name": "codebases:applications:list", - "parameters": [ - { - "name": "codebaseId", - "in": "path", - "description": "The codebase entity's unique identifier.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "security": [ - { - "Codebase_Service_JWT": [] - } - ] - } - }, - "/codebases/{codebaseId}/references": { - "get": { - "operationId": "get_references_by_codebase", - "tags": [ - "Codebases" - ], - "responses": { - "200": { - "description": "Retrieves a list of git references by codebase.", - "content": { - "application/hal+json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "example": 1 - }, - "total": { - "type": "integer", - "example": 1 - }, - "pagination": { - "type": "object", - "properties": { - "total": { - "type": "integer", - "example": 1 - }, - "limit": { - "type": "integer", - "example": 25 - }, - "offset": { - "type": "integer", - "example": 0 - } - } - }, - "_embedded": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "parent": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687" - } - } - }, - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references" - } - } - } - } - }, - "id": { - "type": "string", - "example": "1234567" - }, - "name": { - "type": "string", - "example": "main" - }, - "type": { - "type": "string", - "example": "BRANCH" - }, - "codebase_id": { - "type": "string", - "format": "uuid", - "example": "47de85b1-14bb-4074-8c1d-f0a2d63db687" - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references" - } - } - }, - "limit": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references{?limit}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "offset": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references{?offset}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "filter": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references{?filter}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "sort": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references{?sort}" + "example": "https://cloud.acquia.com/api/codebases/47de85b1-14bb-4074-8c1d-f0a2d63db687/references{?sort}" }, "templated": { "type": "boolean", @@ -39016,6 +40126,12 @@ } }, "/codebases/{codebaseId}/references/{referenceName}": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "get_single_reference", "tags": [ @@ -39166,203 +40282,158 @@ ] } }, - "/site-instances/{siteId}.{environmentId}/database": { - "get": { - "operationId": "site_instance_database", - "x-cli-name": "site-instances:database", - "x-prerelease": true, - "tags": [], + "/private-networks": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "post": { + "summary": "Create a new Private Network", + "description": "Creates a new Private Network with optional subresource configuration.\n\nThis comprehensive endpoint allows you to create a private network and optionally configure \nits subresources (connections, VPNs, VPC peers, ingress, and isolation) during the initial creation.\n\n**Subresource Creation:**\n- **Connections**: Configure CIDR block and egress access settings\n- **VPNs**: Create one or more VPN connections with tunnel configurations\n- **VPC Peers**: Create one or more VPC peering connections\n- **Ingress**: Configure ingress access rules and privacy settings\n- **Isolation**: Configure compute and network isolation flags\n\nAll subresources are optional. If not specified during creation, they can be configured later\nusing their respective endpoints.\n", + "tags": [ + "Private Networks" + ], + "operationId": "createPrivateNetwork", + "x-cli-name": "private-networks:create", + "requestBody": { + "$ref": "#/components/requestBodies/Private_Network_Service_API_PrivateNetworkCreateRequest" + }, "responses": { - "200": { - "description": "Database details", + "202": { + "description": "Request accepted", "content": { "application/hal+json": { "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/database" - } - } - } - } - }, - "database_host": { - "type": "string", - "example": "localhost" - }, - "database_name": { - "type": "string", - "example": "example" - }, - "database_role": { - "type": "string", - "example": "example" - }, - "database_password": { - "type": "string", - "example": "example@123" - }, - "database_user_name": { - "type": "string", - "example": "example" + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "Private network is being created", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000" } } } } } }, - "401": { - "description": "Authorization required.", + "400": { + "description": "Request failed to be validated", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "system" - }, - "message": { - "type": "string", - "example": "Full authentication is required to access this resource." - }, - "code": { - "type": "integer", - "example": 401 - } + "$ref": "#/components/schemas/Private_Network_Service_API_ValidationError" + }, + "example": { + "error": "validation_failed", + "message": { + "region": "Invalid region specified", + "name": "Name is required and must be unique" } } } } }, - "403": { - "description": "Access Denied", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." - }, - "code": { - "type": "integer", - "example": 403 - } - } - } - } - } + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, - "404": { - "description": "Database not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "not found" - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } }, - "summary": "Retrieve database info based on the site instance.", - "description": "Retrieve database info based on the site instance.", - "parameters": [ + "security": [ { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + } + }, + "/private-networks/{privateNetworkId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "get": { + "summary": "Retrieve a Private Network by ID", + "parameters": [ { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" } ], - "deprecated": false, + "operationId": "getPrivateNetwork", + "description": "Retrieves a Private Network by its ID.", + "x-cli-name": "private-networks:find", + "tags": [ + "Private Networks" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Private_Network_Service_API_PrivateNetwork" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, "security": [ { - "MEO_Environment_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] }, - "post": { - "operationId": "api_site-instances_siteId._environmentIddatabase_post", - "x-cli-name": "site-instances:database:copy", - "x-prerelease": true, - "tags": [], + "put": { + "summary": "Update a Private Network", + "description": "Updates an existing Private Network by its ID. Does not allow creation of new Private Networks.", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "operationId": "updatePrivateNetwork", + "x-cli-name": "private-networks:update", + "tags": [ + "Private Networks" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Private_Network_Service_API_UpdatePrivateNetworkRequestSpec" + }, + "example": { + "description": "Private network for customer", + "label": "anyLabel" + } + } + } + }, "responses": { "202": { - "description": "Copied database from one environment to another.", + "description": "Private network updated", "content": { "application/hal+json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Database copy for site id 3e8ecbec-ea7c-4260-8414-ef2938c859bc from e8a2c3c1-baf3-4d9a-9b56-87d8f61ab9f7 to d9a0fe17-cb18-4c21-b8ea-9e3a0b7b4c18 started." - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site/3e8ecbec-ea7c-4260-8414-ef2938c859bc/databases" - } - } - } - } + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "Private network update is in progress", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" } } } @@ -39370,314 +40441,55 @@ } }, "400": { - "description": "Validation Error in request body.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "validation_failed" - }, - "message": { - "type": "string", - "example": "Invalid request body." - }, - "code": { - "type": "integer", - "example": 400 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" }, "401": { - "description": "Authorization required.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "system" - }, - "message": { - "type": "string", - "example": "Full authentication is required to access this resource." - }, - "code": { - "type": "integer", - "example": 401 - } - } - } - } - } - }, - "403": { - "description": "Access Denied", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." - }, - "code": { - "type": "integer", - "example": 403 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, "404": { - "description": "not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "Not Found." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" }, - "422": { - "description": "Unprocessable entity" - } - }, - "summary": "Copy a database from one environment to another.", - "description": "Copy a database from one environment to another.", - "parameters": [ - { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" }, - { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } - ], - "requestBody": { - "description": "Database copy request with source and destination environment ids.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "source_environment_id": { - "type": "string", - "example": "e8a2c3c1-baf3-4d9a-9b56-87d8f61ab9f7" - } - } - } - } - }, - "required": false }, - "deprecated": false, "security": [ { - "MEO_Environment_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] - } - }, - "/site-instances/{siteId}.{environmentId}/database/backups": { - "get": { - "operationId": "get_database_backups", - "x-cli-name": "site-instances:database:backups", - "x-prerelease": true, - "tags": [], + }, + "delete": { + "summary": "Delete a Private Network", + "description": "Deletes a Private Network by its ID.", + "operationId": "deletePrivateNetwork", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "x-cli-name": "private-networks:delete", + "tags": [ + "Private Networks" + ], "responses": { - "200": { - "description": "List Database backups of site instance.", + "202": { + "description": "Private network deleted", "content": { "application/hal+json": { "schema": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "example": 1 - }, - "total": { - "type": "integer", - "example": 1 - }, - "pagination": { - "type": "object", - "properties": { - "total": { - "type": "integer", - "example": 1 - }, - "limit": { - "type": "integer", - "example": 25 - }, - "offset": { - "type": "integer", - "example": 1 - } - } - }, - "_embedded": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "e0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" - }, - "database_id": { - "type": "string", - "example": "b0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" - }, - "created_at": { - "type": "string", - "example": "2025-04-01T13:01:06.603Z" - }, - "type": { - "type": "string", - "example": "DAILY" - }, - "_links": { - "type": "string", - "example": "www.example.com" - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25&offset=1" - } - } - }, - "limit": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?offset=1{&limit}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "offset": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25{&offset}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "filter": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25&offset=1{&filter}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "sort": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25&offset=1{&sort}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "prev": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25&offset=1" - } - } - } - } + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "Private network is being deleted", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" } } } @@ -39685,179 +40497,154 @@ } }, "401": { - "description": "Authorization required.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "system" - }, - "message": { - "type": "string", - "example": "Full authentication is required to access this resource." - }, - "code": { - "type": "integer", - "example": 401 - } - } - } - } - } - }, - "403": { - "description": "Access Denied", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." - }, - "code": { - "type": "integer", - "example": 403 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, "404": { - "description": "Database Backup not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "Not Found." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } }, - "summary": "Retrieves collection of database backups associated with site(a site-instance).", - "description": "Retrieves collection of database backups associated with site(a site-instance).", + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + } + }, + "/subscriptions/{subscriptionId}/private-networks": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "get": { + "summary": "List Private Networks for a Subscription", + "operationId": "getPrivateNetworksBySubscription", + "description": "Retrieves a paginated list of Private Networks for a given subscription.", + "x-cli-name": "private-networks:list", + "tags": [ + "Private Networks" + ], "parameters": [ { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_SubscriptionId" }, { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_Limit" }, { - "name": "offset", - "in": "query", - "description": "The collection page number", - "required": false, - "deprecated": false, - "allowEmptyValue": true, - "schema": { - "type": "integer", - "default": 1 - }, - "style": "form", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_Offset" }, { - "name": "limit", - "in": "query", - "description": "The number of items per page", - "required": false, - "deprecated": false, - "allowEmptyValue": true, - "schema": { - "type": "integer", - "default": 25, - "minimum": 0 - }, - "style": "form", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_Sort" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_Filter" } ], - "deprecated": false, + "responses": { + "200": { + "$ref": "#/components/responses/Private_Network_Service_API_PrivateNetworkList" + }, + "400": { + "$ref": "#/components/responses/Private_Network_Service_API_ValidationError" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "403": { + "$ref": "#/components/responses/Private_Network_Service_API_ForbiddenError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, "security": [ { - "MEO_Environment_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] - }, + } + }, + "/private-networks/{privateNetworkId}/connections/vpns": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], "post": { - "operationId": "api_site-instances_siteId._environmentIddatabasebackups_post", - "x-cli-name": "site-instances:database:backups:create", - "x-prerelease": true, - "tags": [], + "summary": "Add a new VPN to an existing private network", + "operationId": "addVpnToPrivateNetwork", + "description": "Adds a new VPN to the connections block of an existing private network", + "x-cli-name": "private-networks:create-vpn", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "tags": [ + "Private Networks" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Private_Network_Service_API_VPN" + }, + "example": { + "name": "vpn2", + "gateway_ip": "10.10.20.20", + "routes": [ + "192.168.1.0/24", + "192.168.2.0/24" + ], + "tunnel1": { + "shared_key": "sharedKey3", + "internal_cidr": "192.2.1.0/24", + "ike_versions": "1", + "startup_action": "start", + "dpd_timeout_action": "stop" + }, + "tunnel2": { + "shared_key": "sharedKey4", + "internal_cidr": "192.2.2.0/24", + "ike_versions": "2", + "startup_action": "start", + "dpd_timeout_action": "stop" + } + } + } + } + }, "responses": { - "201": { - "description": "Created backup for the site instance Db.", + "202": { + "description": "VPN request accepted", "content": { "application/hal+json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Database backup started." + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "VPN is being created", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns/2" }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/d9a0fe17-cb18-4c21-b8ea-9e3a0b7b4c18.e8a2c3c1-baf3-4d9a-9b56-87d8f61ab9f7/database/backups" - } - } - } - } + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns" } } } @@ -39865,377 +40652,276 @@ } }, "400": { - "description": "Validation Error in request body.", + "description": "Bad request", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "validation_failed" - }, - "message": { - "type": "string", - "example": "Invalid request body." - }, - "code": { - "type": "integer", - "example": 400 - } + "$ref": "#/components/schemas/Private_Network_Service_API_ValidationError" + }, + "example": { + "error": "validation_failed", + "message": { + "gateway_ip": "Invalid IP address format" } } } } }, "401": { - "description": "Authorization required.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "system" - }, - "message": { - "type": "string", - "example": "Full authentication is required to access this resource." - }, - "code": { - "type": "integer", - "example": 401 - } - } - } - } - } - }, - "403": { - "description": "Access Denied", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." - }, - "code": { - "type": "integer", - "example": 403 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, "404": { - "description": "Database not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "not found" - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" }, - "422": { - "description": "Unprocessable entity" + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } }, - "summary": "Create a new backup for the site instance Db.", - "description": "Create a new backup for the site instance Db.", + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + }, + "get": { + "summary": "Get VPNs for a Private Network", + "operationId": "getAllVpnsFromPrivateNetwork", + "description": "Retrieves the VPN Connections for a Private Network.", + "x-cli-name": "private-networks:list-vpns", "parameters": [ { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" }, { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_Limit" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_Offset" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_Sort" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_Filter" } ], - "deprecated": false, + "tags": [ + "Private Networks" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Private_Network_Service_API_VPNList" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, "security": [ { - "MEO_Environment_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] } }, - "/site-instances/{siteId}.{environmentId}/database/backups/{id}": { + "/private-networks/{privateNetworkId}/connections/vpns/{vpnId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], "get": { - "operationId": "get_database_backup", - "x-cli-name": "site-instances:database:backups:get", - "x-prerelease": true, - "tags": [], + "summary": "Retrieve a VPN for a Private Network.", + "operationId": "getVpnFromPrivateNetwork", + "description": "Retrieves a VPN for a Private Network by Private Network ID and VPN ID.", + "x-cli-name": "private-networks:find-vpn", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_VpnId" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "tags": [ + "Private Networks" + ], "responses": { "200": { - "description": "Database Backup details", - "content": { - "application/hal+json": { - "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/database/backups/a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" - } - } - }, - "parent": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/database/backups" - } - } - }, - "site-instance": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323" - } - } - }, - "site": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/sites/3e8ecbec-ea7c-4260-8414-ef2938c859bc" - } - } - }, - "environment": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/environments/d3f7270e-c45f-4801-9308-5e8afe84a323" - } - } - } - } - }, - "id": { - "type": "string", - "example": "e0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" - }, - "database_id": { - "type": "string", - "example": "b0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" - }, - "created_at": { - "type": "string", - "example": "2025-04-01T13:01:06.603Z" - }, - "type": { - "type": "string", - "example": "DAILY" - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_Vpn" }, "401": { - "description": "Authorization required.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "system" - }, - "message": { - "type": "string", - "example": "Full authentication is required to access this resource." - }, - "code": { - "type": "integer", - "example": 401 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, - "403": { - "description": "Access Denied", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." - }, - "code": { - "type": "integer", - "example": 403 - } - } + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + }, + "put": { + "summary": "Create or update a VPN for a Private Network.", + "operationId": "updateVpnInPrivateNetwork", + "description": "Creates a new VPN or updates an existing VPN for a Private Network by Private Network ID and VPN ID.", + "x-cli-name": "private-networks:update-vpn", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_VpnId" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "tags": [ + "Private Networks" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Private_Network_Service_API_VPN" + }, + "example": { + "name": "vpn1", + "gateway_ip": "10.10.10.11", + "routes": [ + "127.0.0.1/32", + "127.0.0.2/32", + "192.168.3.0/24" + ], + "tunnel1": { + "shared_key": "updatedSharedKey1", + "internal_cidr": "192.1.1.0/24", + "ike_versions": "1", + "startup_action": "start", + "dpd_timeout_action": "stop" + }, + "tunnel2": { + "shared_key": "updatedSharedKey2", + "internal_cidr": "192.1.2.0/24", + "ike_versions": "2", + "startup_action": "start", + "dpd_timeout_action": "stop" } } } - }, - "404": { - "description": "Database Backup not found.", + } + }, + "responses": { + "202": { + "description": "VPN request accepted", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "Not Found." - }, - "code": { - "type": "integer", - "example": 404 + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "examples": { + "creation": { + "summary": "VPN creation response", + "description": "Response when creating a new VPN", + "value": { + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections/vpns/1" + } + }, + "message": "The VPN is being created." + } + }, + "update": { + "summary": "VPN update response", + "description": "Response when updating an existing VPN", + "value": { + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections/vpns/1" + } + }, + "message": "The VPN is being updated." } } } } } - } - }, - "summary": "Retrieves details about a backup by its id associated with site(a site-instance)", - "description": "Retrieves details about a backup by its id associated with site(a site-instance)", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Database backup unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false }, - { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "400": { + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" }, - { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } - ], - "deprecated": false, + }, "security": [ { - "MEO_Environment_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] }, "delete": { - "operationId": "api_site-instances_siteId._environmentIddatabasebackups_id_delete", - "x-cli-name": "site-instances:database:backups:delete", - "x-prerelease": true, - "tags": [], + "summary": "Delete a VPN for a Private Network.", + "operationId": "deleteVpnFromPrivateNetwork", + "description": "Deletes a VPN for a Private Network by Private Network ID and VPN ID.", + "x-cli-name": "private-networks:delete-vpn", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_VpnId" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "tags": [ + "Private Networks" + ], "responses": { "202": { - "description": "Delete a site instance database backup", + "description": "VPN removed successfully", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Database backup deletion started." + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "The VPN is being deleted.", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns/1" + }, + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000" } } } @@ -40243,169 +40929,229 @@ } }, "401": { - "description": "Authorization required.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "system" - }, - "message": { - "type": "string", - "example": "Full authentication is required to access this resource." - }, - "code": { - "type": "integer", - "example": 401 - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + } + }, + "/private-networks/{privateNetworkId}/connections/vpc-peers": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "post": { + "summary": "Add a new VPC Peer to an existing private network", + "operationId": "addVpcPeerToPrivateNetwork", + "description": "Adds a new VPC Peer to the connections block of an existing private network", + "x-cli-name": "private-networks:create-vpc-peer", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "tags": [ + "Private Networks" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Private_Network_Service_API_VPCPeers" + }, + "example": { + "name": "vpcPeer2", + "aws_account": "123456789012", + "vpc_id": "vpc-1234567890abcdef0", + "vpc_cidr": "120.24.16.1/24", + "region": "eu-central-1" } } - }, - "403": { - "description": "Access Denied", + } + }, + "responses": { + "202": { + "description": "VPC Peer request accepted", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "VPC Peer is being created", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers/2" }, - "code": { - "type": "integer", - "example": 403 + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers" } } } } } }, + "400": { + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, "404": { - "description": "Database Backup not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "Not Found." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" } }, - "summary": "Delete a site instance database backup", - "description": "Delete a site instance database backup", + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + }, + "get": { + "summary": "Get VPC Peers for a Private Network", + "operationId": "getAllVpcPeersFromPrivateNetwork", + "description": "Retrieves the VPC Peers for a Private Network.", + "x-cli-name": "private-networks:list-vpc-peers", "parameters": [ { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" }, { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_Limit" }, { - "name": "id", - "in": "path", - "description": "Backup unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_Offset" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_Sort" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_Filter" } ], - "deprecated": false, + "tags": [ + "Private Networks" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Private_Network_Service_API_VpcPeerList" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, "security": [ { - "MEO_Environment_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] } }, - "/site-instances/{siteId}.{environmentId}/database/backups/{id}/actions/download": { + "/private-networks/{privateNetworkId}/connections/vpc-peers/{vpcPeerId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], "get": { - "operationId": "api_site-instances_siteId._environmentIddatabasebackups_idactionsdownload_get", - "x-cli-name": "site-instances:database:backups:download", - "x-prerelease": true, - "tags": [], + "summary": "Get a specific VPC Peer from a private network", + "operationId": "getVpcPeerFromPrivateNetwork", + "description": "Retrieves details of a specific VPC Peer from a private network", + "x-cli-name": "private-networks:find-vpc-peer", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_VpcPeerId" + } + ], + "tags": [ + "Private Networks" + ], "responses": { "200": { - "description": "DatabaseBackup resource", - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/MEO_Environment_Service_DatabaseBackup.jsonhal" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MEO_Environment_Service_DatabaseBackup" - } - }, - "text/html": { - "schema": { - "$ref": "#/components/schemas/MEO_Environment_Service_DatabaseBackup" - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_VpcPeer" }, - "201": { - "description": "Download a site instance Db backup", + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + }, + "delete": { + "summary": "Delete a VPC Peer for a Private Network.", + "operationId": "deleteVpcPeerFromPrivateNetwork", + "description": "Deletes a VPC Peer for a Private Network by Private Network ID and VPC Peer name.", + "x-cli-name": "private-networks:delete-vpc-peer", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_VpcPeerId" + } + ], + "tags": [ + "Private Networks" + ], + "responses": { + "202": { + "description": "VPC Peer removed successfully", "content": { "application/hal+json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Database backup download started." + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "The VPC Peer is being deleted.", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers/1" + }, + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000" } } } @@ -40413,174 +41159,226 @@ } }, "401": { - "description": "Authorization required.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "system" - }, - "message": { - "type": "string", - "example": "Full authentication is required to access this resource." - }, - "code": { - "type": "integer", - "example": 401 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, - "403": { - "description": "Access Denied", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." - }, - "code": { - "type": "integer", - "example": 403 - } - } + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + } + }, + "/private-networks/{privateNetworkId}/connections": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "put": { + "summary": "Update Connections for a Private Network.", + "operationId": "updatePrivateNetworkConnections", + "description": "Updates the Connections configuration for a Private Network by Private Network ID.", + "x-cli-name": "private-networks:update-connections", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "tags": [ + "Private Networks" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Private_Network_Service_API_UpdateConnectionRequestSpec" + }, + "example": { + "private_egress_access": { + "drupal": true } } } - }, - "404": { - "description": "Database Backup not found.", + } + }, + "responses": { + "202": { + "description": "Connections updated", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "Not Found." + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "Private network connections update is in progress", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections" }, - "code": { - "type": "integer", - "example": 404 + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" } } } } } + }, + "400": { + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } }, - "summary": "Download a site instance Database backup", - "description": "Download a site instance Database backup.", + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + }, + "get": { + "summary": "Get Connections for a Private Network.", + "operationId": "getPrivateNetworkConnections", + "x-cli-name": "private-networks:get-connections", "parameters": [ { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "description": "Retrieves the Connections block for a Private Network, including VPNs and VPC Peers.", + "tags": [ + "Private Networks" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Private_Network_Service_API_Connection" }, - { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, - { - "name": "id", - "in": "path", - "description": "Backup unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } - ], - "deprecated": false, + }, "security": [ { - "MEO_Environment_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] } }, - "/site-instances/{siteId}.{environmentId}/database/backups/{id}/actions/restore": { - "post": { - "operationId": "restore_database_backup", - "x-cli-name": "site-instances:database:backups:restore", - "x-prerelease": true, - "tags": [], + "/private-networks/{privateNetworkId}/isolation": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "get": { + "summary": "Get Isolation for a Private Network.", + "operationId": "getPrivateNetworkIsolation", + "description": "Retrieves the Isolation configuration for a Private Network.", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "x-cli-name": "private-networks:get-isolation", + "tags": [ + "Private Networks" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Private_Network_Service_API_Isolation" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + }, + "put": { + "summary": "Update isolation settings of a private network", + "operationId": "updatePrivateNetworkIsolation", + "description": "Updates the isolation settings of a private network", + "tags": [ + "Private Networks" + ], + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "x-cli-name": "private-networks:update-isolation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Private_Network_Service_API_Isolation" + }, + "example": { + "dedicated_compute": true, + "dedicated_network": true + } + } + } + }, "responses": { "202": { - "description": "Restore database backup", + "description": "Isolation settings updated", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "parent": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups/1" - } - } - }, - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups/1/actions/restore" - } - } - } - } + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "Private network isolation settings have been updated successfully.", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/isolation" }, - "message": { - "type": "string", - "example": "Database restore started." + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" } } } @@ -40588,203 +41386,169 @@ } }, "400": { - "description": "Invalid input" + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" }, "401": { - "description": "Authorization required.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "system" - }, - "message": { - "type": "string", - "example": "Full authentication is required to access this resource." - }, - "code": { - "type": "integer", - "example": 401 - } - } + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + } + }, + "/private-networks/{privateNetworkId}/ingress": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "put": { + "summary": "Update Ingress for a Private Network.", + "operationId": "updatePrivateNetworkIngress", + "x-cli-name": "private-networks:update-ingress", + "description": "Updates the Ingress configuration for a Private Network by Private Network ID. Ingress always exists for a Private Network.", + "parameters": [ + { + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "tags": [ + "Private Networks" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Private_Network_Service_API_Ingress" + }, + "example": { + "drupal_ssh": { + "ingress_acls": [ + "test-acls" + ], + "private": true } } } - }, - "403": { - "description": "Access Denied", + } + }, + "responses": { + "202": { + "description": "Ingress settings updated", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "example": { + "message": "Private network ingress settings have been updated successfully.", + "_links": { + "self": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/ingress" }, - "code": { - "type": "integer", - "example": 403 + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" } } } } } }, + "400": { + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + }, "404": { - "description": "Database Backup not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "Not Found." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" }, - "422": { - "description": "Unprocessable entity" + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } }, - "summary": "Restore a backup for the site instance Db", - "description": "Restore a backup for the site instance Db.", + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + }, + "get": { + "summary": "Get Ingress for a Private Network", + "operationId": "getIngressFromPrivateNetwork", + "x-cli-name": "private-networks:get-ingress", + "description": "Retrieves the Ingress configuration for a Private Network.", "parameters": [ { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + } + ], + "tags": [ + "Private Networks" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Private_Network_Service_API_Ingress" }, - { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, - { - "name": "id", - "in": "path", - "description": "Backup unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false + "404": { + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } - ], - "deprecated": false, + }, "security": [ { - "MEO_Environment_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] } }, - "/site-instances/{siteId}.{environmentId}/domains": { + "/v3/environments/{environmentId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { - "operationId": "site_instance_domains", - "x-cli-name": "site-instances:domains", + "operationId": "environment_by_id", + "x-cli-name": "environments-v3:find", "x-prerelease": true, "tags": [], "responses": { - "200": { - "description": "List of site instance domains.", - "content": { - "application/hal+json": { - "schema": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "example": 1 - }, - "total": { - "type": "integer", - "example": 1 - }, - "pagination": { - "type": "object", - "properties": { - "total": { - "type": "integer", - "example": 1 - }, - "limit": { - "type": "integer", - "example": 25 - }, - "offset": { - "type": "integer", - "example": 1 - } - } - }, - "_embedded": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "domain": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "example.com" - }, - "is_managed": { - "type": "boolean", - "example": true - } - } - } - } - } - } - } - }, + "200": { + "description": "Environment details", + "content": { + "application/hal+json": { + "schema": { + "type": "object", + "properties": { "_links": { "type": "object", "properties": { @@ -40794,73 +41558,106 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.3e8ecbec-ea7c-4260-8414-ef2938c859bc/domains?limit=25&offset=1" - } - } - }, - "limit": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?offset=1{&limit}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "offset": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25{&offset}" - }, - "templated": { - "type": "boolean", - "example": true + "example": "https://cloud.acquia.com/api/environments/3e8ecbec-ea7c-4260-8414-ef2938c859bc" } } }, - "filter": { + "codebase": { "type": "object", "properties": { "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25&offset=1{&filter}" - }, - "templated": { - "type": "boolean", - "example": true + "example": "https://cloud.acquia.com/api/codebases/d3f7270e-c45f-4801-9308-5e8afe84a323" } } - }, - "sort": { + } + } + }, + "id": { + "type": "string", + "format": "uuid", + "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "name": { + "type": "string", + "example": "environment_3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "label": { + "type": "string", + "example": "Environment_3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "description": { + "type": "string", + "example": "Description of 3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "status": { + "type": "string", + "example": "normal" + }, + "flags": { + "type": "object", + "example": { + "production": false + } + }, + "properties": { + "type": "object", + "example": { + "version": "8.3", + "max_execution_time": 10, + "memory_limit": 192, + "apcu": 32, + "client_max_body_size": 192, + "max_input_vars": 1000, + "max_post_size": 256, + "memcached_limit": 128, + "upload_max_filesize": 192, + "operating_system": "focal" + } + }, + "reference": { + "type": "string", + "example": "tag/v3.1" + }, + "code_switch_status": { + "type": "string", + "enum": [ + "IDLE", + "IN_PROGRESS" + ], + "example": "IDLE", + "description": "The status of the Switch Code action" + }, + "ssh_url": { + "type": "string", + "format": "string", + "example": "site.dev@sitedev.ssh.hosted.acquia-sites.com" + }, + "_embedded": { + "type": "object", + "properties": { + "codebase": { "type": "object", "properties": { - "href": { + "id": { "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25&offset=1{&sort}" + "example": "d3f7270e-c45f-4801-9308-5e8afe84a323" }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "prev": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25&offset=1" + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/d3f7270e-c45f-4801-9308-5e8afe84a323" + } + } + } + } } } } @@ -40920,7 +41717,7 @@ } }, "404": { - "description": "Site instance Domain not found.", + "description": "Environment not found.", "content": { "application/json": { "schema": { @@ -40932,7 +41729,7 @@ }, "message": { "type": "string", - "example": "The domains for the site instance with id {site_id}.{environment_id} you are trying to access does not exist, or you do not have permission to access it." + "example": "Not Found." }, "code": { "type": "integer", @@ -40944,23 +41741,9 @@ } } }, - "summary": "Retrieves all site instance domains by environment and site ID.", - "description": "Retrieves all site instance domains by environment and site ID.", + "summary": "Retrieves an environment details by its uuid.", + "description": "Retrieves an environment details by its uuid.", "parameters": [ - { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, { "name": "environmentId", "in": "path", @@ -40974,37 +41757,6 @@ "style": "simple", "explode": false, "allowReserved": false - }, - { - "name": "offset", - "in": "query", - "description": "The collection page number", - "required": false, - "deprecated": false, - "allowEmptyValue": true, - "schema": { - "type": "integer", - "default": 1 - }, - "style": "form", - "explode": false, - "allowReserved": false - }, - { - "name": "limit", - "in": "query", - "description": "The number of items per page", - "required": false, - "deprecated": false, - "allowEmptyValue": true, - "schema": { - "type": "integer", - "default": 25, - "minimum": 0 - }, - "style": "form", - "explode": false, - "allowReserved": false } ], "deprecated": false, @@ -41013,22 +41765,24 @@ "MEO_Environment_Service_JWT": [] } ] - } - }, - "/site-instances/{siteId}.{environmentId}/domains/{domainName}": { - "get": { - "operationId": "site_instance_domain", - "x-cli-name": "site-instances:domain", + }, + "put": { + "operationId": "update_environment", + "x-cli-name": "environments-v3:update", "x-prerelease": true, "tags": [], "responses": { - "200": { - "description": "Domain details", + "202": { + "description": "Successful start of environment properties update.", "content": { "application/hal+json": { "schema": { "type": "object", "properties": { + "message": { + "type": "string", + "example": "Environment update started." + }, "_links": { "type": "object", "properties": { @@ -41038,24 +41792,35 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains/example.com" + "example": "https://cloud.acquia.com/api/environments/a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" } } } } + } + } + } + } + } + }, + "400": { + "description": "Validation Error in request body.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "validation_failed" }, - "domain": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "example.com" - }, - "is_managed": { - "type": "boolean", - "example": true - } - } + "message": { + "type": "string", + "example": "Invalid request body." + }, + "code": { + "type": "integer", + "example": 400 } } } @@ -41111,7 +41876,7 @@ } }, "404": { - "description": "Domain not found.", + "description": "Environment not found.", "content": { "application/json": { "schema": { @@ -41123,7 +41888,7 @@ }, "message": { "type": "string", - "example": "The domain provided does not exist." + "example": "Not Found." }, "code": { "type": "integer", @@ -41133,15 +41898,18 @@ } } } + }, + "422": { + "description": "Unprocessable entity" } }, - "summary": "Retrieves site instance domain details by environment and site ID.", - "description": "Retrieves site instance domain details by environment and site ID.", + "summary": "Modifies properties settings for an environment.", + "description": "Modifies properties settings for an environment. Note that some settings cannot be configured for certain subscriptions.", "parameters": [ { - "name": "siteId", + "name": "environmentId", "in": "path", - "description": "Site unique identifier", + "description": "Environment unique identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -41151,25 +41919,144 @@ "style": "simple", "explode": false, "allowReserved": false + } + ], + "requestBody": { + "description": "The updated Environment resource", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "label": { + "type": "string", + "example": "test-environment" + }, + "description": { + "type": "string", + "example": "environment-description" + }, + "properties": { + "type": "object", + "example": { + "version": "8.3", + "max_execution_time": 10, + "memory_limit": 192, + "apcu": 32, + "client_max_body_size": 192, + "max_input_vars": 1000, + "max_post_size": 256, + "memcached_limit": 128, + "upload_max_filesize": 192, + "operating_system": "focal" + }, + "minProperties": 1 + } + }, + "minProperties": 1 + } + } }, + "required": false + }, + "deprecated": false, + "security": [ { - "name": "environmentId", + "MEO_Environment_Service_JWT": [] + } + ] + } + }, + "/codebases/{codebaseId}/sites": { + "servers": [ + { + "url": "/", + "description": "" + } + ], + "get": { + "tags": [], + "summary": "Retrieves a list of sites associated with a codebase.", + "operationId": "api_codebases_codebaseIdsites_get_collection", + "x-cli-name": "codebases:sites-list", + "x-prerelease": true, + "parameters": [ + { + "name": "codebaseId", "in": "path", - "description": "Environment unique identifier", "required": true, - "deprecated": false, - "allowEmptyValue": false, + "description": "The codebase identifier.", "schema": { "type": "string" }, - "style": "simple", - "explode": false, - "allowReserved": false + "example": "d3f7270e-c45f-4801-9308-5e8afe84a323" + } + ], + "security": [ + { + "Acquia_Cloud_API_Documentation_OAuth2": [] + } + ], + "responses": { + "200": { + "description": "A list of sites associated with a codebase.", + "content": { + "application/hal+json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "8979a8ac-80dc-4df8-b2f0-6be36554a370" + }, + "name": { + "type": "string", + "example": "site2" + }, + "label": { + "type": "string", + "example": "My Site 2" + } + } + }, + "example": { + "id": "8979a8ac-80dc-4df8-b2f0-6be36554a370", + "name": "site2", + "label": "My Site 2" + } + } + } + }, + "401": { + "description": "Unauthorized" }, + "404": { + "description": "Not found" + } + } + } + }, + "/codebases/{codebaseId}/applications": { + "servers": [ + { + "url": "/", + "description": "" + } + ], + "get": { + "operationId": "codebase_applications", + "x-prerelease": true, + "tags": [ + "Codebases" + ], + "summary": "Retrieves a list of applications by codebase ID.", + "description": "Retrieves the collection of application resources from codebase ID. If the user has admin-level access, no filter is applied. Otherwise, the resources are filtered based on the requesting user's permissions.", + "x-cli-name": "codebases:applications:list", + "parameters": [ { - "name": "domainName", + "name": "codebaseId", "in": "path", - "description": "Domain Name", + "description": "The codebase entity's unique identifier.", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -41184,18 +42071,70 @@ "deprecated": false, "security": [ { - "MEO_Environment_Service_JWT": [] + "Codebase_Service_JWT": [] } - ] - }, - "put": { - "operationId": "add_domain_to_site", - "x-cli-name": "site-instances:domain:add", + ], + "responses": { + "200": { + "description": "Retrieves a list of applications by codebase ID.", + "content": { + "application/hal+json": { + "schema": { + "type": "object", + "properties": { + "_embedded": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "App1" + }, + "machine_name": { + "type": "string", + "example": "APP_NAME" + } + } + } + } + } + } + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Codebase not found." + } + } + } + }, + "/site-instances/{siteId}.{environmentId}/database": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "get": { + "operationId": "site_instance_database", + "x-cli-name": "site-instances:database", "x-prerelease": true, "tags": [], "responses": { - "201": { - "description": "Domain updated", + "200": { + "description": "Database details", "content": { "application/hal+json": { "schema": { @@ -41210,24 +42149,37 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains/example.com" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/database" } } } } }, - "name": { + "database_host": { "type": "string", - "example": "example.com" + "example": "localhost" + }, + "database_name": { + "type": "string", + "example": "example" + }, + "database_role": { + "type": "string", + "example": "example" + }, + "database_password": { + "type": "string", + "example": "example@123" + }, + "database_user_name": { + "type": "string", + "example": "example" } } } } } }, - "400": { - "description": "Invalid input" - }, "401": { "description": "Authorization required.", "content": { @@ -41277,7 +42229,7 @@ } }, "404": { - "description": "Domain not found.", + "description": "Database not found.", "content": { "application/json": { "schema": { @@ -41289,7 +42241,7 @@ }, "message": { "type": "string", - "example": "The domain provided does not exist." + "example": "not found" }, "code": { "type": "integer", @@ -41299,13 +42251,10 @@ } } } - }, - "422": { - "description": "Unprocessable entity" } }, - "summary": "Associate a site and environment with a domain.", - "description": "Associate a site and environment with a domain.", + "summary": "Retrieve database info based on the site instance.", + "description": "Retrieve database info based on the site instance.", "parameters": [ { "name": "siteId", @@ -41333,35 +42282,9 @@ }, "style": "simple", "explode": false, - "allowReserved": false - }, - { - "name": "domainName", - "in": "path", - "description": "Domain Name", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The updated Domain resource", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": false - } - } - }, - "required": false - }, + "allowReserved": false + } + ], "deprecated": false, "security": [ { @@ -41369,22 +42292,61 @@ } ] }, - "delete": { - "operationId": "api_site-instances_siteId._environmentIddomains_domainName_delete", - "x-cli-name": "site-instances:domain:delete", + "post": { + "operationId": "api_site-instances_siteId._environmentIddatabase_post", + "x-cli-name": "site-instances:database:copy", "x-prerelease": true, "tags": [], "responses": { "202": { - "description": "Dissociate a site and environment from a domain", + "description": "Copied database from one environment to another.", + "content": { + "application/hal+json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Database copy for site id 3e8ecbec-ea7c-4260-8414-ef2938c859bc from e8a2c3c1-baf3-4d9a-9b56-87d8f61ab9f7 to d9a0fe17-cb18-4c21-b8ea-9e3a0b7b4c18 started." + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site/3e8ecbec-ea7c-4260-8414-ef2938c859bc/databases" + } + } + } + } + } + } + } + } + } + }, + "400": { + "description": "Validation Error in request body.", "content": { "application/json": { "schema": { "type": "object", "properties": { + "error": { + "type": "string", + "example": "validation_failed" + }, "message": { "type": "string", - "example": "www.example.com domain deletion for site_id:3e8ecbec-ea7c-4260-8414-ef2938c859bc started." + "example": "Invalid request body." + }, + "code": { + "type": "integer", + "example": 400 } } } @@ -41440,7 +42402,7 @@ } }, "404": { - "description": "Domain not found.", + "description": "not found.", "content": { "application/json": { "schema": { @@ -41462,25 +42424,14 @@ } } } + }, + "422": { + "description": "Unprocessable entity" } }, - "summary": "Dissociate a site and environment from a domain.", - "description": "Dissociate a site and environment from a domain.", + "summary": "Copy a database from one environment to another.", + "description": "Copy a database from one environment to another.", "parameters": [ - { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - }, { "name": "environmentId", "in": "path", @@ -41496,9 +42447,9 @@ "allowReserved": false }, { - "name": "domainName", + "name": "siteId", "in": "path", - "description": "Domain Name", + "description": "Site unique identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -41510,6 +42461,23 @@ "allowReserved": false } ], + "requestBody": { + "description": "Database copy request with source and destination environment ids.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "source_environment_id": { + "type": "string", + "example": "e8a2c3c1-baf3-4d9a-9b56-87d8f61ab9f7" + } + } + } + } + }, + "required": false + }, "deprecated": false, "security": [ { @@ -41518,20 +42486,84 @@ ] } }, - "/site-instances/{siteId}.{environmentId}/domains/{domainName}/status": { + "/site-instances/{siteId}.{environmentId}/database/backups": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { - "operationId": "site_instance_domain_status", - "x-cli-name": "site-instances:domain:status", + "operationId": "get_database_backups", + "x-cli-name": "site-instances:database:backups", "x-prerelease": true, "tags": [], "responses": { "200": { - "description": "Domain Status", + "description": "List Database backups of site instance.", "content": { "application/hal+json": { "schema": { "type": "object", "properties": { + "count": { + "type": "integer", + "example": 1 + }, + "total": { + "type": "integer", + "example": 1 + }, + "pagination": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "example": 1 + }, + "limit": { + "type": "integer", + "example": 25 + }, + "offset": { + "type": "integer", + "example": 1 + } + } + }, + "_embedded": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "e0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" + }, + "database_id": { + "type": "string", + "example": "b0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" + }, + "created_at": { + "type": "string", + "example": "2025-04-01T13:01:06.603Z" + }, + "type": { + "type": "string", + "example": "DAILY" + }, + "_links": { + "type": "string", + "example": "www.example.com" + } + } + } + } + } + }, "_links": { "type": "object", "properties": { @@ -41541,51 +42573,77 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.3e8ecbec-ea7c-4260-8414-ef2938c859bc/domains/www.example.com/status" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25&offset=1" + } + } + }, + "limit": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?offset=1{&limit}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "offset": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25{&offset}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "filter": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25&offset=1{&filter}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "sort": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25&offset=1{&sort}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "prev": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups?limit=25&offset=1" } } } } - }, - "site-id": { - "type": "string", - "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "environment-id": { - "type": "string", - "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "hostname": { - "type": "string", - "example": "www.example.com" - }, - "flags": { - "type": "object", - "example": { - "default": false, - "active": true, - "dns_resolves": true, - "acquia_hosted": true - } - }, - "ip_addresses": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "192.0.2.1" - ] - }, - "cnames": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "cname1.example.com", - "cname2.example.com" - ] } } } @@ -41641,7 +42699,7 @@ } }, "404": { - "description": "Domain not found.", + "description": "Database Backup not found.", "content": { "application/json": { "schema": { @@ -41665,8 +42723,8 @@ } } }, - "summary": "Retrieves site instance domain status.", - "description": "Retrieves site instance domain status.", + "summary": "Retrieves collection of database backups associated with site(a site-instance).", + "description": "Retrieves collection of database backups associated with site(a site-instance).", "parameters": [ { "name": "siteId", @@ -41697,16 +42755,33 @@ "allowReserved": false }, { - "name": "domainName", - "in": "path", - "description": "Domain Name", - "required": true, + "name": "offset", + "in": "query", + "description": "The collection page number", + "required": false, "deprecated": false, - "allowEmptyValue": false, + "allowEmptyValue": true, "schema": { - "type": "string" + "type": "integer", + "default": 1 }, - "style": "simple", + "style": "form", + "explode": false, + "allowReserved": false + }, + { + "name": "limit", + "in": "query", + "description": "The number of items per page", + "required": false, + "deprecated": false, + "allowEmptyValue": true, + "schema": { + "type": "integer", + "default": 25, + "minimum": 0 + }, + "style": "form", "explode": false, "allowReserved": false } @@ -41717,173 +42792,204 @@ "MEO_Environment_Service_JWT": [] } ] - } - }, - "/codebases/{codebaseId}/environments": { - "get": { - "operationId": "environments_by_codebase", - "x-cli-name": "codebases:environments-list", + }, + "post": { + "operationId": "api_site-instances_siteId._environmentIddatabasebackups_post", + "x-cli-name": "site-instances:database:backups:create", "x-prerelease": true, "tags": [], "responses": { - "200": { - "description": "List of environments.", + "201": { + "description": "Created backup for the site instance Db.", "content": { "application/hal+json": { "schema": { "type": "object", "properties": { - "count": { - "type": "integer", - "example": 1 - }, - "total": { - "type": "integer", - "example": 1 - }, - "pagination": { - "type": "object", - "properties": { - "total": { - "type": "integer", - "example": 1 - }, - "limit": { - "type": "integer", - "example": 25 - }, - "offset": { - "type": "integer", - "example": 1 - } - } + "message": { + "type": "string", + "example": "Database backup started." }, - "_embedded": { + "_links": { "type": "object", "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/environments/1111-1111-1111" - } - } - }, - "codebase": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc" - } - } - } - } - }, - "id": { - "type": "string", - "example": "1111-1111-1111" - }, - "name": { - "type": "string", - "example": "environment_1111-1111-1111" - }, - "label": { - "type": "string", - "example": "Environment 1111-1111-1111" - }, - "description": { - "type": "string", - "example": "Description of1111-1111-1111" - }, - "status": { - "type": "string", - "example": "normal" - }, - "flags": { - "type": "object", - "example": { - "production": false - } - }, - "properties": { - "type": "object", - "example": { - "version": "8.3", - "max_execution_time": 10, - "memory_limit": 192, - "apcu": 32, - "client_max_body_size": 192, - "max_input_vars": 1000, - "max_post_size": 256, - "memcached_limit": 128, - "upload_max_filesize": 192, - "operating_system": "focal" - } - }, - "reference": { - "type": "string", - "example": "tag/v3.1" - }, - "code_switch_status": { - "type": "string", - "enum": [ - "IDLE", - "IN_PROGRESS" - ], - "example": "IDLE", - "description": "The status of the Switch Code action" - }, - "ssh_url": { - "type": "string", - "format": "string", - "example": "site.dev@sitedev.ssh.hosted.acquia-sites.com" - }, - "_embedded": { - "type": "object", - "properties": { - "codebase": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1111-1111-1111" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/1111-1111-1111" - } - } - } - } - } - } - } - } - } + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/d9a0fe17-cb18-4c21-b8ea-9e3a0b7b4c18.e8a2c3c1-baf3-4d9a-9b56-87d8f61ab9f7/database/backups" } } } } + } + } + } + } + } + }, + "400": { + "description": "Validation Error in request body.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "validation_failed" + }, + "message": { + "type": "string", + "example": "Invalid request body." + }, + "code": { + "type": "integer", + "example": 400 + } + } + } + } + } + }, + "401": { + "description": "Authorization required.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "system" + }, + "message": { + "type": "string", + "example": "Full authentication is required to access this resource." + }, + "code": { + "type": "integer", + "example": 401 + } + } + } + } + } + }, + "403": { + "description": "Access Denied", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "forbidden" + }, + "message": { + "type": "string", + "example": "Access Denied." }, + "code": { + "type": "integer", + "example": 403 + } + } + } + } + } + }, + "404": { + "description": "Database not found.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "not_found" + }, + "message": { + "type": "string", + "example": "not found" + }, + "code": { + "type": "integer", + "example": 404 + } + } + } + } + } + }, + "422": { + "description": "Unprocessable entity" + } + }, + "summary": "Create a new backup for the site instance Db.", + "description": "Create a new backup for the site instance Db.", + "parameters": [ + { + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + }, + { + "name": "environmentId", + "in": "path", + "description": "Environment unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + } + ], + "deprecated": false, + "security": [ + { + "MEO_Environment_Service_JWT": [] + } + ] + } + }, + "/site-instances/{siteId}.{environmentId}/database/backups/{id}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "get": { + "operationId": "get_database_backup", + "x-cli-name": "site-instances:database:backups:get", + "x-prerelease": true, + "tags": [], + "responses": { + "200": { + "description": "Database Backup details", + "content": { + "application/hal+json": { + "schema": { + "type": "object", + "properties": { "_links": { "type": "object", "properties": { @@ -41893,77 +42999,67 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25&offset=1" - } - } - }, - "limit": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?offset=1{&limit}" - }, - "templated": { - "type": "boolean", - "example": true + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/database/backups/a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" } } }, - "offset": { + "parent": { "type": "object", "properties": { "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25{&offset}" - }, - "templated": { - "type": "boolean", - "example": true + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/database/backups" } } }, - "filter": { + "site-instance": { "type": "object", "properties": { "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25&offset=1{&filter}" - }, - "templated": { - "type": "boolean", - "example": true + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323" } } }, - "sort": { + "site": { "type": "object", "properties": { "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25&offset=1{&sort}" - }, - "templated": { - "type": "boolean", - "example": true + "example": "https://cloud.acquia.com/api/sites/3e8ecbec-ea7c-4260-8414-ef2938c859bc" } } }, - "prev": { + "environment": { "type": "object", "properties": { "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25&offset=1" + "example": "https://cloud.acquia.com/api/environments/d3f7270e-c45f-4801-9308-5e8afe84a323" } } } } + }, + "id": { + "type": "string", + "example": "e0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" + }, + "database_id": { + "type": "string", + "example": "b0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" + }, + "created_at": { + "type": "string", + "example": "2025-04-01T13:01:06.603Z" + }, + "type": { + "type": "string", + "example": "DAILY" } } } @@ -42019,7 +43115,7 @@ } }, "404": { - "description": "Environment not found.", + "description": "Database Backup not found.", "content": { "application/json": { "schema": { @@ -42043,56 +43139,41 @@ } } }, - "summary": "Retrieves all environments by codebase.", - "description": "Retrieves all environments by codebase.", + "summary": "Retrieves details about a backup by its id associated with site(a site-instance)", + "description": "Retrieves details about a backup by its id associated with site(a site-instance)", "parameters": [ { - "name": "limit", - "in": "query", - "description": "The number of items per page.", - "required": false, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "integer" - }, - "style": "form", - "explode": false, - "allowReserved": false - }, - { - "name": "offset", - "in": "query", - "description": "The index of the first item in the page.", - "required": false, + "name": "id", + "in": "path", + "description": "Database backup unique identifier", + "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { - "type": "integer" + "type": "string" }, - "style": "form", + "style": "simple", "explode": false, "allowReserved": false }, { - "name": "filter", - "in": "query", - "description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do get included in the result by testing each row in the result against the filters. Not all fields are filterable. Current we only support filter by **name**", - "required": false, + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, "deprecated": false, "allowEmptyValue": false, "schema": { - "type": "string", - "example": "name=dev" + "type": "string" }, - "style": "form", + "style": "simple", "explode": false, "allowReserved": false }, { - "name": "codebaseId", + "name": "environmentId", "in": "path", - "description": "Codebase entity unique identifier", + "description": "Environment unique identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -42110,135 +43191,23 @@ "MEO_Environment_Service_JWT": [] } ] - } - }, - "/codebases/{codebaseId}/environments/{environmentId}": { - "get": { - "operationId": "environment_by_codebase_id", - "x-cli-name": "codebases:environments-find", + }, + "delete": { + "operationId": "api_site-instances_siteId._environmentIddatabasebackups_id_delete", + "x-cli-name": "site-instances:database:backups:delete", "x-prerelease": true, "tags": [], "responses": { - "200": { - "description": "Environment details", + "202": { + "description": "Delete a site instance database backup", "content": { - "application/hal+json": { + "application/json": { "schema": { "type": "object", "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/environments/3e8ecbec-ea7c-4260-8414-ef2938c859bc" - } - } - }, - "codebase": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/d3f7270e-c45f-4801-9308-5e8afe84a323" - } - } - } - } - }, - "id": { - "type": "string", - "format": "uuid", - "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "name": { - "type": "string", - "example": "environment_3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "label": { - "type": "string", - "example": "Environment_3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "description": { - "type": "string", - "example": "Description of 3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "status": { - "type": "string", - "example": "normal" - }, - "flags": { - "type": "object", - "example": { - "production": false - } - }, - "properties": { - "type": "object", - "example": { - "version": "8.3", - "max_execution_time": 10, - "memory_limit": 192, - "apcu": 32, - "client_max_body_size": 192, - "max_input_vars": 1000, - "max_post_size": 256, - "memcached_limit": 128, - "upload_max_filesize": 192, - "operating_system": "focal" - } - }, - "reference": { - "type": "string", - "example": "tag/v3.1" - }, - "code_switch_status": { - "type": "string", - "enum": [ - "IDLE", - "IN_PROGRESS" - ], - "example": "IDLE", - "description": "The status of the Switch Code action" - }, - "ssh_url": { + "message": { "type": "string", - "format": "string", - "example": "site.dev@sitedev.ssh.hosted.acquia-sites.com" - }, - "_embedded": { - "type": "object", - "properties": { - "codebase": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "d3f7270e-c45f-4801-9308-5e8afe84a323" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/d3f7270e-c45f-4801-9308-5e8afe84a323" - } - } - } - } - } - } - } - } + "example": "Database backup deletion started." } } } @@ -42294,7 +43263,7 @@ } }, "404": { - "description": "Environment not found.", + "description": "Database Backup not found.", "content": { "application/json": { "schema": { @@ -42318,13 +43287,13 @@ } } }, - "summary": "Retrieves the details for an environment based on codebase and environment uuid.", - "description": "Retrieves the details for an environment based on codebase and environment uuid.", + "summary": "Delete a site instance database backup", + "description": "Delete a site instance database backup", "parameters": [ { - "name": "codebaseId", + "name": "siteId", "in": "path", - "description": "Codebase entity unique identifier", + "description": "Site unique identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -42348,6 +43317,20 @@ "style": "simple", "explode": false, "allowReserved": false + }, + { + "name": "id", + "in": "path", + "description": "Backup unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], "deprecated": false, @@ -42358,133 +43341,49 @@ ] } }, - "/v3/environments/{environmentId}": { + "/site-instances/{siteId}.{environmentId}/database/backups/{id}/actions/download": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { - "operationId": "environment_by_id", - "x-cli-name": "environments-v3:find", + "operationId": "api_site-instances_siteId._environmentIddatabasebackups_idactionsdownload_get", + "x-cli-name": "site-instances:database:backups:download", "x-prerelease": true, "tags": [], "responses": { "200": { - "description": "Environment details", + "description": "DatabaseBackup resource", "content": { "application/hal+json": { "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/environments/3e8ecbec-ea7c-4260-8414-ef2938c859bc" - } - } - }, - "codebase": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/d3f7270e-c45f-4801-9308-5e8afe84a323" - } - } - } - } - }, - "id": { - "type": "string", - "format": "uuid", - "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "name": { - "type": "string", - "example": "environment_3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "label": { - "type": "string", - "example": "Environment_3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "description": { - "type": "string", - "example": "Description of 3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "status": { - "type": "string", - "example": "normal" - }, - "flags": { - "type": "object", - "example": { - "production": false - } - }, - "properties": { - "type": "object", - "example": { - "version": "8.3", - "max_execution_time": 10, - "memory_limit": 192, - "apcu": 32, - "client_max_body_size": 192, - "max_input_vars": 1000, - "max_post_size": 256, - "memcached_limit": 128, - "upload_max_filesize": 192, - "operating_system": "focal" - } - }, - "reference": { - "type": "string", - "example": "tag/v3.1" - }, - "code_switch_status": { - "type": "string", - "enum": [ - "IDLE", - "IN_PROGRESS" - ], - "example": "IDLE", - "description": "The status of the Switch Code action" - }, - "ssh_url": { - "type": "string", - "format": "string", - "example": "site.dev@sitedev.ssh.hosted.acquia-sites.com" - }, - "_embedded": { - "type": "object", - "properties": { - "codebase": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "d3f7270e-c45f-4801-9308-5e8afe84a323" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/d3f7270e-c45f-4801-9308-5e8afe84a323" - } - } - } - } - } - } - } - } + "$ref": "#/components/schemas/MEO_Environment_Service_DatabaseBackup.jsonhal" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MEO_Environment_Service_DatabaseBackup" + } + }, + "text/html": { + "schema": { + "$ref": "#/components/schemas/MEO_Environment_Service_DatabaseBackup" + } + } + } + }, + "201": { + "description": "Download a site instance Db backup", + "content": { + "application/hal+json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Database backup download started." } } } @@ -42540,7 +43439,7 @@ } }, "404": { - "description": "Environment not found.", + "description": "Database Backup not found.", "content": { "application/json": { "schema": { @@ -42564,9 +43463,23 @@ } } }, - "summary": "Retrieves an environment details by its uuid.", - "description": "Retrieves an environment details by its uuid.", + "summary": "Download a site instance Database backup", + "description": "Download a site instance Database backup.", "parameters": [ + { + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + }, { "name": "environmentId", "in": "path", @@ -42580,6 +43493,20 @@ "style": "simple", "explode": false, "allowReserved": false + }, + { + "name": "id", + "in": "path", + "description": "Backup unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], "deprecated": false, @@ -42588,68 +43515,65 @@ "MEO_Environment_Service_JWT": [] } ] - }, - "put": { - "operationId": "update_environment", - "x-cli-name": "environments-v3:update", + } + }, + "/site-instances/{siteId}.{environmentId}/database/backups/{id}/actions/restore": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "post": { + "operationId": "restore_database_backup", + "x-cli-name": "site-instances:database:backups:restore", "x-prerelease": true, "tags": [], "responses": { "202": { - "description": "Successful start of environment properties update.", + "description": "Restore database backup", "content": { - "application/hal+json": { + "application/json": { "schema": { "type": "object", "properties": { - "message": { - "type": "string", - "example": "Environment update started." - }, "_links": { "type": "object", "properties": { + "parent": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups/1" + } + } + }, "self": { "type": "object", "properties": { "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/environments/a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3/database/backups/1/actions/restore" } } } } - } - } - } - } - } - }, - "400": { - "description": "Validation Error in request body.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "validation_failed" }, "message": { "type": "string", - "example": "Invalid request body." - }, - "code": { - "type": "integer", - "example": 400 + "example": "Database restore started." } } } } } }, + "400": { + "description": "Invalid input" + }, "401": { "description": "Authorization required.", "content": { @@ -42699,7 +43623,7 @@ } }, "404": { - "description": "Environment not found.", + "description": "Database Backup not found.", "content": { "application/json": { "schema": { @@ -42726,9 +43650,23 @@ "description": "Unprocessable entity" } }, - "summary": "Modifies properties settings for an environment.", - "description": "Modifies properties settings for an environment. Note that some settings cannot be configured for certain subscriptions.", + "summary": "Restore a backup for the site instance Db", + "description": "Restore a backup for the site instance Db.", "parameters": [ + { + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + }, { "name": "environmentId", "in": "path", @@ -42742,46 +43680,22 @@ "style": "simple", "explode": false, "allowReserved": false + }, + { + "name": "id", + "in": "path", + "description": "Backup unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], - "requestBody": { - "description": "The updated Environment resource", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "label": { - "type": "string", - "example": "test-environment" - }, - "description": { - "type": "string", - "example": "environment-description" - }, - "properties": { - "type": "object", - "example": { - "version": "8.3", - "max_execution_time": 10, - "memory_limit": 192, - "apcu": 32, - "client_max_body_size": 192, - "max_input_vars": 1000, - "max_post_size": 256, - "memcached_limit": 128, - "upload_max_filesize": 192, - "operating_system": "focal" - }, - "minProperties": 1 - } - }, - "minProperties": 1 - } - } - }, - "required": false - }, "deprecated": false, "security": [ { @@ -42790,15 +43704,21 @@ ] } }, - "/sites/{siteId}/environments": { + "/site-instances/{siteId}.{environmentId}/domains": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { - "operationId": "environments_by_site", - "x-cli-name": "sites:environments-list", + "operationId": "site_instance_domains", + "x-cli-name": "site-instances:domains", "x-prerelease": true, "tags": [], "responses": { "200": { - "description": "List of environments.", + "description": "List of site instance domains.", "content": { "application/hal+json": { "schema": { @@ -42837,126 +43757,16 @@ "items": { "type": "object", "properties": { - "_links": { + "domain": { "type": "object", "properties": { - "site_instance": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/site-id.env-id" - } - } - }, - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/sites/site-id/environments" - } - } + "name": { + "type": "string", + "example": "example.com" }, - "codebase": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc" - } - } - } - } - }, - "id": { - "type": "string", - "example": "1111-1111-1111" - }, - "name": { - "type": "string", - "example": "environment_1111-1111-1111" - }, - "label": { - "type": "string", - "example": "Environment 1111-1111-1111" - }, - "description": { - "type": "string", - "example": "Description of 1111-1111-1111" - }, - "status": { - "type": "string", - "example": "normal" - }, - "flags": { - "type": "object", - "example": { - "production": false - } - }, - "properties": { - "type": "object", - "example": { - "version": "8.3", - "max_execution_time": 10, - "memory_limit": 192, - "apcu": 32, - "client_max_body_size": 192, - "max_input_vars": 1000, - "max_post_size": 256, - "memcached_limit": 128, - "upload_max_filesize": 192, - "operating_system": "focal" - } - }, - "reference": { - "type": "string", - "example": "tag/v3.1" - }, - "code_switch_status": { - "type": "string", - "enum": [ - "IDLE", - "IN_PROGRESS" - ], - "example": "IDLE", - "description": "The status of the Switch Code action" - }, - "ssh_url": { - "type": "string", - "format": "string", - "example": "site.dev@sitedev.ssh.hosted.acquia-sites.com" - }, - "_embedded": { - "type": "object", - "properties": { - "codebase": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1111-1111-1111" - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/codebases/1111-1111-1111" - } - } - } - } - } - } + "is_managed": { + "type": "boolean", + "example": true } } } @@ -42974,7 +43784,7 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25&offset=1" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.3e8ecbec-ea7c-4260-8414-ef2938c859bc/domains?limit=25&offset=1" } } }, @@ -42984,7 +43794,7 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/sites/site-id/environments?offset=1{&limit}" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?offset=1{&limit}" }, "templated": { "type": "boolean", @@ -42998,7 +43808,7 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25{&offset}" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25{&offset}" }, "templated": { "type": "boolean", @@ -43012,7 +43822,7 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25&offset=1{&filter}" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25&offset=1{&filter}" }, "templated": { "type": "boolean", @@ -43026,7 +43836,7 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25&offset=1{&sort}" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25&offset=1{&sort}" }, "templated": { "type": "boolean", @@ -43040,7 +43850,7 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25&offset=1" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25&offset=1" } } } @@ -43100,7 +43910,7 @@ } }, "404": { - "description": "Environment not found.", + "description": "Site instance Domain not found.", "content": { "application/json": { "schema": { @@ -43112,7 +43922,7 @@ }, "message": { "type": "string", - "example": "Not Found." + "example": "The domains for the site instance with id {site_id}.{environment_id} you are trying to access does not exist, or you do not have permission to access it." }, "code": { "type": "integer", @@ -43124,8 +43934,8 @@ } } }, - "summary": "Retrieves all environments by site.", - "description": "Retrieves all environments by site.", + "summary": "Retrieves all site instance domains by environment and site ID.", + "description": "Retrieves all site instance domains by environment and site ID.", "parameters": [ { "name": "siteId", @@ -43141,6 +43951,20 @@ "explode": false, "allowReserved": false }, + { + "name": "environmentId", + "in": "path", + "description": "Environment unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + }, { "name": "offset", "in": "query", @@ -43181,24 +44005,26 @@ ] } }, - "/environments/{environmentId}/site-instances": { - "post": { - "operationId": "api_environments_environmentIdsite-instances_post", - "x-cli-name": "environments:site-instances:create", + "/site-instances/{siteId}.{environmentId}/domains/{domainName}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "get": { + "operationId": "site_instance_domain", + "x-cli-name": "site-instances:domain", "x-prerelease": true, "tags": [], "responses": { - "201": { - "description": "Site instance creation started.", + "200": { + "description": "Domain details", "content": { "application/hal+json": { "schema": { "type": "object", "properties": { - "message": { - "type": "string", - "example": "Site instance for site_id:3fa85f64-5717-4562-b3fc-2c963f66afa6 creation started." - }, "_links": { "type": "object", "properties": { @@ -43208,35 +44034,24 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/environments/d3f7270e-c45f-4801-9308-5e8afe84a323/site-instances" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains/example.com" } } } } - } - } - } - } - } - }, - "400": { - "description": "Validation Error in request body.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "validation_failed" - }, - "message": { - "type": "string", - "example": "Invalid request body." }, - "code": { - "type": "integer", - "example": 400 + "domain": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "example.com" + }, + "is_managed": { + "type": "boolean", + "example": true + } + } } } } @@ -43280,7 +44095,7 @@ }, "message": { "type": "string", - "example": "The site instance already exists." + "example": "Access Denied." }, "code": { "type": "integer", @@ -43292,7 +44107,7 @@ } }, "404": { - "description": "not found.", + "description": "Domain not found.", "content": { "application/json": { "schema": { @@ -43304,7 +44119,7 @@ }, "message": { "type": "string", - "example": "Not Found." + "example": "The domain provided does not exist." }, "code": { "type": "integer", @@ -43314,14 +44129,25 @@ } } } - }, - "422": { - "description": "Unprocessable entity" } }, - "summary": "Associate a site with an environment.", - "description": "Associate a site with an environment.", + "summary": "Retrieves site instance domain details by environment and site ID.", + "description": "Retrieves site instance domain details by environment and site ID.", "parameters": [ + { + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + }, { "name": "environmentId", "in": "path", @@ -43335,42 +44161,37 @@ "style": "simple", "explode": false, "allowReserved": false + }, + { + "name": "domainName", + "in": "path", + "description": "Domain Name", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], - "requestBody": { - "description": "The new SiteInstance resource", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "site_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - } - } - } - }, - "required": false - }, "deprecated": false, "security": [ { "MEO_Environment_Service_JWT": [] } ] - } - }, - "/site-instances/{siteId}.{environmentId}": { - "get": { - "operationId": "site_instance", - "x-cli-name": "site-instances:find", + }, + "put": { + "operationId": "add_domain_to_site", + "x-cli-name": "site-instances:domain:add", "x-prerelease": true, "tags": [], "responses": { - "200": { - "description": "Site Instance details", + "201": { + "description": "Domain updated", "content": { "application/hal+json": { "schema": { @@ -43385,57 +44206,24 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323" - } - } - } - } - }, - "site_id": { - "type": "string", - "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" - }, - "environment_id": { - "type": "string", - "example": "d3f7270e-c45f-4801-9308-5e8afe84a323" - }, - "status": { - "type": "string", - "example": "active" - }, - "health_status": { - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "OK" - }, - "summary": { - "type": "string", - "example": "The health status is OK." - }, - "details": { - "type": "string", - "example": "The site instance is active" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323/domains/example.com" + } + } } } }, - "domains": { - "type": "array", - "items": { - "type": "string", - "example": "example.com" - }, - "example": [ - "example.com", - "example-2.com" - ] + "name": { + "type": "string", + "example": "example.com" } } } } } }, + "400": { + "description": "Invalid input" + }, "401": { "description": "Authorization required.", "content": { @@ -43485,7 +44273,7 @@ } }, "404": { - "description": "Site Instance not found.", + "description": "Domain not found.", "content": { "application/json": { "schema": { @@ -43497,7 +44285,7 @@ }, "message": { "type": "string", - "example": "Not Found." + "example": "The domain provided does not exist." }, "code": { "type": "integer", @@ -43507,10 +44295,13 @@ } } } + }, + "422": { + "description": "Unprocessable entity" } }, - "summary": "Retrieves details about an environment association with a site (a site instance).", - "description": "Retrieves details about an environment association with a site (a site instance).", + "summary": "Associate a site and environment with a domain.", + "description": "Associate a site and environment with a domain.", "parameters": [ { "name": "siteId", @@ -43539,8 +44330,34 @@ "style": "simple", "explode": false, "allowReserved": false + }, + { + "name": "domainName", + "in": "path", + "description": "Domain Name", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], + "requestBody": { + "description": "The updated Domain resource", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false + } + } + }, + "required": false + }, "deprecated": false, "security": [ { @@ -43549,35 +44366,21 @@ ] }, "delete": { - "operationId": "api_site-instances_siteId._environmentId_delete", + "operationId": "api_site-instances_siteId._environmentIddomains_domainName_delete", + "x-cli-name": "site-instances:domain:delete", "x-prerelease": true, "tags": [], "responses": { "202": { - "description": "Site Instance deleted", + "description": "Dissociate a site and environment from a domain", "content": { - "application/hal+json": { + "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", - "example": "Site instance deletion started." - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/d3f7270e-c45f-4801-9308-5e8afe84a323.e3f7270e-c45f-4801-9308-5e8afe84a323" - } - } - } - } + "example": "www.example.com domain deletion for site_id:3e8ecbec-ea7c-4260-8414-ef2938c859bc started." } } } @@ -43633,7 +44436,7 @@ } }, "404": { - "description": "Site Instance not found.", + "description": "Domain not found.", "content": { "application/json": { "schema": { @@ -43657,8 +44460,8 @@ } } }, - "summary": "Dissociate a site and environment with no grace period.", - "description": "Dissociate a site and environment with no grace period.", + "summary": "Dissociate a site and environment from a domain.", + "description": "Dissociate a site and environment from a domain.", "parameters": [ { "name": "siteId", @@ -43687,6 +44490,20 @@ "style": "simple", "explode": false, "allowReserved": false + }, + { + "name": "domainName", + "in": "path", + "description": "Domain Name", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], "deprecated": false, @@ -43697,24 +44514,26 @@ ] } }, - "/site-instances/{siteId}.{environmentId}/actions/cancel": { - "post": { - "operationId": "api_site-instances_siteId._environmentIdactionscancel_post", - "x-cli-name": "site-instances:dissociate", + "/site-instances/{siteId}.{environmentId}/domains/{domainName}/status": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "get": { + "operationId": "site_instance_domain_status", + "x-cli-name": "site-instances:domain:status", "x-prerelease": true, "tags": [], "responses": { - "202": { - "description": "Site Instance deleted", + "200": { + "description": "Domain Status", "content": { "application/hal+json": { "schema": { "type": "object", "properties": { - "message": { - "type": "string", - "example": "Site instance deletion started." - }, "_links": { "type": "object", "properties": { @@ -43724,20 +44543,57 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/site-instances/d3f7270e-c45f-4801-9308-5e8afe84a323.e3f7270e-c45f-4801-9308-5e8afe84a323" + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.3e8ecbec-ea7c-4260-8414-ef2938c859bc/domains/www.example.com/status" } } } } + }, + "site-id": { + "type": "string", + "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "environment-id": { + "type": "string", + "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "hostname": { + "type": "string", + "example": "www.example.com" + }, + "flags": { + "type": "object", + "example": { + "default": false, + "active": true, + "dns_resolves": true, + "acquia_hosted": true + } + }, + "ip_addresses": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "cnames": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "cname1.example.com", + "cname2.example.com" + ] } } } } } }, - "400": { - "description": "Invalid input" - }, "401": { "description": "Authorization required.", "content": { @@ -43787,7 +44643,7 @@ } }, "404": { - "description": "Site Instance not found.", + "description": "Domain not found.", "content": { "application/json": { "schema": { @@ -43809,13 +44665,10 @@ } } } - }, - "422": { - "description": "Unprocessable entity" } }, - "summary": "Dissociate a site and environment.", - "description": "Dissociate a site and environment.", + "summary": "Retrieves site instance domain status.", + "description": "Retrieves site instance domain status.", "parameters": [ { "name": "siteId", @@ -43844,29 +44697,22 @@ "style": "simple", "explode": false, "allowReserved": false + }, + { + "name": "domainName", + "in": "path", + "description": "Domain Name", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], - "requestBody": { - "description": "The new SiteInstance resource", - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/MEO_Environment_Service_SiteInstance.jsonhal" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MEO_Environment_Service_SiteInstance" - } - }, - "text/html": { - "schema": { - "$ref": "#/components/schemas/MEO_Environment_Service_SiteInstance" - } - } - }, - "required": true - }, "deprecated": false, "security": [ { @@ -43875,23 +44721,176 @@ ] } }, - "/site-instances/{siteId}.{environmentId}/files": { - "post": { - "operationId": "api_site-instances_siteId._environmentIdfiles_post", - "x-cli-name": "site-instances:files:copy", + "/codebases/{codebaseId}/environments": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "get": { + "operationId": "environments_by_codebase", + "x-cli-name": "codebases:environments-list", "x-prerelease": true, "tags": [], "responses": { - "202": { - "description": "Copy files from one environment to another", + "200": { + "description": "List of environments.", "content": { "application/hal+json": { "schema": { "type": "object", "properties": { - "message": { - "type": "string", - "example": "Files copy for site id 3fa85f64-5717-4562-b3fc-2c9699999999 from 3fa85f64-5717-4562-b3fc-2c963f66afa6 to 4fa85f64-5717-4562-b3fc-2c963f66afa3 started." + "count": { + "type": "integer", + "example": 1 + }, + "total": { + "type": "integer", + "example": 1 + }, + "pagination": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "example": 1 + }, + "limit": { + "type": "integer", + "example": 25 + }, + "offset": { + "type": "integer", + "example": 1 + } + } + }, + "_embedded": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/environments/1111-1111-1111" + } + } + }, + "codebase": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc" + } + } + } + } + }, + "id": { + "type": "string", + "example": "1111-1111-1111" + }, + "name": { + "type": "string", + "example": "environment_1111-1111-1111" + }, + "label": { + "type": "string", + "example": "Environment 1111-1111-1111" + }, + "description": { + "type": "string", + "example": "Description of1111-1111-1111" + }, + "status": { + "type": "string", + "example": "normal" + }, + "flags": { + "type": "object", + "example": { + "production": false + } + }, + "properties": { + "type": "object", + "example": { + "version": "8.3", + "max_execution_time": 10, + "memory_limit": 192, + "apcu": 32, + "client_max_body_size": 192, + "max_input_vars": 1000, + "max_post_size": 256, + "memcached_limit": 128, + "upload_max_filesize": 192, + "operating_system": "focal" + } + }, + "reference": { + "type": "string", + "example": "tag/v3.1" + }, + "code_switch_status": { + "type": "string", + "enum": [ + "IDLE", + "IN_PROGRESS" + ], + "example": "IDLE", + "description": "The status of the Switch Code action" + }, + "ssh_url": { + "type": "string", + "format": "string", + "example": "site.dev@sitedev.ssh.hosted.acquia-sites.com" + }, + "_embedded": { + "type": "object", + "properties": { + "codebase": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "1111-1111-1111" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/1111-1111-1111" + } + } + } + } + } + } + } + } + } + } + } + } + } }, "_links": { "type": "object", @@ -43902,7 +44901,73 @@ "href": { "type": "string", "format": "string", - "example": "https://cloud.acquia.com/api/site/3fa85f64-5717-4562-b3fc-2c9699999999/files" + "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25&offset=1" + } + } + }, + "limit": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?offset=1{&limit}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "offset": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25{&offset}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "filter": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25&offset=1{&filter}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "sort": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25&offset=1{&sort}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "prev": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc/environments?limit=25&offset=1" } } } @@ -43913,30 +44978,6 @@ } } }, - "400": { - "description": "Validation Error in request body.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "validation_failed" - }, - "message": { - "type": "string", - "example": "Invalid request body." - }, - "code": { - "type": "integer", - "example": 400 - } - } - } - } - } - }, "401": { "description": "Authorization required.", "content": { @@ -43986,7 +45027,7 @@ } }, "404": { - "description": "not found.", + "description": "Environment not found.", "content": { "application/json": { "schema": { @@ -44008,32 +45049,58 @@ } } } - }, - "422": { - "description": "Unprocessable entity" } }, - "summary": "Copy files from one environment to another.", - "description": "Copy files from one environment to another.", + "summary": "Retrieves all environments by codebase.", + "description": "Retrieves all environments by codebase.", "parameters": [ { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, + "name": "limit", + "in": "query", + "description": "The number of items per page.", + "required": false, "deprecated": false, "allowEmptyValue": false, "schema": { - "type": "string" + "type": "integer" }, - "style": "simple", + "style": "form", + "explode": false, + "allowReserved": false + }, + { + "name": "offset", + "in": "query", + "description": "The index of the first item in the page.", + "required": false, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "integer" + }, + "style": "form", + "explode": false, + "allowReserved": false + }, + { + "name": "filter", + "in": "query", + "description": "The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do get included in the result by testing each row in the result against the filters. Not all fields are filterable. Current we only support filter by **name**", + "required": false, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string", + "example": "name=dev" + }, + "style": "form", "explode": false, "allowReserved": false }, { - "name": "siteId", + "name": "codebaseId", "in": "path", - "description": "Site unique identifier", + "description": "Codebase entity unique identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -44045,23 +45112,6 @@ "allowReserved": false } ], - "requestBody": { - "description": "The new SiteInstance resource", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "source_environment_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - } - } - } - }, - "required": false - }, "deprecated": false, "security": [ { @@ -44070,15 +45120,21 @@ ] } }, - "/v3/environments/{environmentId}/actions/clear-caches": { - "post": { - "operationId": "postV3EnvironmentsClearCaches", - "x-cli-name": "environments-v3:clear-caches", + "/codebases/{codebaseId}/environments/{environmentId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "get": { + "operationId": "environment_by_codebase_id", + "x-cli-name": "codebases:environments-find", "x-prerelease": true, "tags": [], "responses": { - "202": { - "description": "Domains cache flush started.", + "200": { + "description": "Environment details", "content": { "application/hal+json": { "schema": { @@ -44092,25 +45148,117 @@ "properties": { "href": { "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/environments/3e8ecbec-ea7c-4260-8414-ef2938c859bc/actions/clear-caches" + "format": "string", + "example": "https://cloud.acquia.com/api/environments/3e8ecbec-ea7c-4260-8414-ef2938c859bc" + } + } + }, + "codebase": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/d3f7270e-c45f-4801-9308-5e8afe84a323" } } } } }, - "message": { + "id": { "type": "string", - "example": "Varnish domain cache clear started." + "format": "uuid", + "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "name": { + "type": "string", + "example": "environment_3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "label": { + "type": "string", + "example": "Environment_3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "description": { + "type": "string", + "example": "Description of 3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "status": { + "type": "string", + "example": "normal" + }, + "flags": { + "type": "object", + "example": { + "production": false + } + }, + "properties": { + "type": "object", + "example": { + "version": "8.3", + "max_execution_time": 10, + "memory_limit": 192, + "apcu": 32, + "client_max_body_size": 192, + "max_input_vars": 1000, + "max_post_size": 256, + "memcached_limit": 128, + "upload_max_filesize": 192, + "operating_system": "focal" + } + }, + "reference": { + "type": "string", + "example": "tag/v3.1" + }, + "code_switch_status": { + "type": "string", + "enum": [ + "IDLE", + "IN_PROGRESS" + ], + "example": "IDLE", + "description": "The status of the Switch Code action" + }, + "ssh_url": { + "type": "string", + "format": "string", + "example": "site.dev@sitedev.ssh.hosted.acquia-sites.com" + }, + "_embedded": { + "type": "object", + "properties": { + "codebase": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "d3f7270e-c45f-4801-9308-5e8afe84a323" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/d3f7270e-c45f-4801-9308-5e8afe84a323" + } + } + } + } + } + } + } + } } } } } } }, - "400": { - "description": "Invalid input" - }, "401": { "description": "Authorization required.", "content": { @@ -44160,7 +45308,7 @@ } }, "404": { - "description": "Domain not found.", + "description": "Environment not found.", "content": { "application/json": { "schema": { @@ -44172,7 +45320,7 @@ }, "message": { "type": "string", - "example": "The domain provided does not exist." + "example": "Not Found." }, "code": { "type": "integer", @@ -44184,9 +45332,23 @@ } } }, - "summary": "Clear caches for an environment with a list of domains.", - "description": "Clear caches for an environment with a list of domains.", + "summary": "Retrieves the details for an environment based on codebase and environment uuid.", + "description": "Retrieves the details for an environment based on codebase and environment uuid.", "parameters": [ + { + "name": "codebaseId", + "in": "path", + "description": "Codebase entity unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + }, { "name": "environmentId", "in": "path", @@ -44202,35 +45364,6 @@ "allowReserved": false } ], - "requestBody": { - "description": "List of domains.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "domains": { - "type": "array", - "items": { - "type": "string", - "example": "example.com" - } - } - }, - "required": [ - "domains" - ] - }, - "example": { - "domains": [ - "example.com", - "another-domain.com" - ] - } - } - }, - "required": false - }, "deprecated": false, "security": [ { @@ -44239,349 +45372,441 @@ ] } }, - "/private-networks": { - "post": { - "summary": "Create a new Private Network", - "description": "Creates a new Private Network with optional subresource configuration.\n\nThis comprehensive endpoint allows you to create a private network and optionally configure \nits subresources (connections, VPNs, VPC peers, ingress, and isolation) during the initial creation.\n\n**Subresource Creation:**\n- **Connections**: Configure CIDR block and egress access settings\n- **VPNs**: Create one or more VPN connections with tunnel configurations\n- **VPC Peers**: Create one or more VPC peering connections\n- **Ingress**: Configure ingress access rules and privacy settings\n- **Isolation**: Configure compute and network isolation flags\n\nAll subresources are optional. If not specified during creation, they can be configured later\nusing their respective endpoints.\n", - "tags": [ - "Private Networks" - ], - "operationId": "createPrivateNetwork", - "x-cli-name": "private-networks:create", - "requestBody": { - "$ref": "#/components/requestBodies/Private_Network_Service_API_PrivateNetworkCreateRequest" - }, + "/sites/{siteId}/environments": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "get": { + "operationId": "environments_by_site", + "x-cli-name": "sites:environments-list", + "x-prerelease": true, + "tags": [], "responses": { - "202": { - "description": "Request accepted", - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "Private network is being created", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000" - } - } - } - } - } - }, - "400": { - "description": "Request failed to be validated", + "200": { + "description": "List of environments.", "content": { "application/hal+json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_ValidationError" - }, - "example": { - "error": "validation_failed", - "message": { - "region": "Invalid region specified", - "name": "Name is required and must be unique" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - } - }, - "/private-networks/{privateNetworkId}": { - "get": { - "summary": "Retrieve a Private Network by ID", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "operationId": "getPrivateNetwork", - "description": "Retrieves a Private Network by its ID.", - "x-cli-name": "private-networks:find", - "tags": [ - "Private Networks" - ], - "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_PrivateNetwork" + "type": "object", + "properties": { + "count": { + "type": "integer", + "example": 1 + }, + "total": { + "type": "integer", + "example": 1 + }, + "pagination": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "example": 1 + }, + "limit": { + "type": "integer", + "example": 25 + }, + "offset": { + "type": "integer", + "example": 1 + } + } + }, + "_embedded": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "site_instance": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/site-id.env-id" + } + } + }, + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/sites/site-id/environments" + } + } + }, + "codebase": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/3e8ecbec-ea7c-4260-8414-ef2938c859bc" + } + } + } + } + }, + "id": { + "type": "string", + "example": "1111-1111-1111" + }, + "name": { + "type": "string", + "example": "environment_1111-1111-1111" + }, + "label": { + "type": "string", + "example": "Environment 1111-1111-1111" + }, + "description": { + "type": "string", + "example": "Description of 1111-1111-1111" + }, + "status": { + "type": "string", + "example": "normal" + }, + "flags": { + "type": "object", + "example": { + "production": false + } + }, + "properties": { + "type": "object", + "example": { + "version": "8.3", + "max_execution_time": 10, + "memory_limit": 192, + "apcu": 32, + "client_max_body_size": 192, + "max_input_vars": 1000, + "max_post_size": 256, + "memcached_limit": 128, + "upload_max_filesize": 192, + "operating_system": "focal" + } + }, + "reference": { + "type": "string", + "example": "tag/v3.1" + }, + "code_switch_status": { + "type": "string", + "enum": [ + "IDLE", + "IN_PROGRESS" + ], + "example": "IDLE", + "description": "The status of the Switch Code action" + }, + "ssh_url": { + "type": "string", + "format": "string", + "example": "site.dev@sitedev.ssh.hosted.acquia-sites.com" + }, + "_embedded": { + "type": "object", + "properties": { + "codebase": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "1111-1111-1111" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/codebases/1111-1111-1111" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25&offset=1" + } + } + }, + "limit": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/sites/site-id/environments?offset=1{&limit}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "offset": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25{&offset}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "filter": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25&offset=1{&filter}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "sort": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25&offset=1{&sort}" + }, + "templated": { + "type": "boolean", + "example": true + } + } + }, + "prev": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/sites/site-id/environments?limit=25&offset=1" + } + } + } + } + } + } + } + } + } }, "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "put": { - "summary": "Update a Private Network", - "description": "Updates an existing Private Network by its ID. Does not allow creation of new Private Networks.", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "operationId": "updatePrivateNetwork", - "x-cli-name": "private-networks:update", - "tags": [ - "Private Networks" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_UpdatePrivateNetworkRequestSpec" - }, - "example": { - "description": "Private network for customer", - "label": "anyLabel" + "description": "Authorization required.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "system" + }, + "message": { + "type": "string", + "example": "Full authentication is required to access this resource." + }, + "code": { + "type": "integer", + "example": 401 + } + } + } } } - } - }, - "responses": { - "202": { - "description": "Private network updated", + }, + "403": { + "description": "Access Denied", "content": { - "application/hal+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "Private network update is in progress", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "forbidden" + }, + "message": { + "type": "string", + "example": "Access Denied." + }, + "code": { + "type": "integer", + "example": 403 } } } } } }, - "400": { - "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "delete": { - "summary": "Delete a Private Network", - "description": "Deletes a Private Network by its ID.", - "operationId": "deletePrivateNetwork", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "x-cli-name": "private-networks:delete", - "tags": [ - "Private Networks" - ], - "responses": { - "202": { - "description": "Private network deleted", + "description": "Environment not found.", "content": { - "application/hal+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "Private network is being deleted", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "not_found" + }, + "message": { + "type": "string", + "example": "Not Found." + }, + "code": { + "type": "integer", + "example": 404 } } } } } - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - } - }, - "/subscriptions/{subscriptionId}/private-networks": { - "get": { - "summary": "List Private Networks for a Subscription", - "operationId": "getPrivateNetworksBySubscription", - "description": "Retrieves a paginated list of Private Networks for a given subscription.", - "x-cli-name": "private-networks:list", - "tags": [ - "Private Networks" - ], + "summary": "Retrieves all environments by site.", + "description": "Retrieves all environments by site.", "parameters": [ { - "$ref": "#/components/parameters/Private_Network_Service_API_SubscriptionId" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Limit" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Offset" + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false }, { - "$ref": "#/components/parameters/Private_Network_Service_API_Sort" + "name": "offset", + "in": "query", + "description": "The collection page number", + "required": false, + "deprecated": false, + "allowEmptyValue": true, + "schema": { + "type": "integer", + "default": 1 + }, + "style": "form", + "explode": false, + "allowReserved": false }, { - "$ref": "#/components/parameters/Private_Network_Service_API_Filter" + "name": "limit", + "in": "query", + "description": "The number of items per page", + "required": false, + "deprecated": false, + "allowEmptyValue": true, + "schema": { + "type": "integer", + "default": 25, + "minimum": 0 + }, + "style": "form", + "explode": false, + "allowReserved": false } ], - "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_PrivateNetworkList" - }, - "400": { - "$ref": "#/components/responses/Private_Network_Service_API_ValidationError" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "403": { - "$ref": "#/components/responses/Private_Network_Service_API_ForbiddenError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, + "deprecated": false, "security": [ { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] + "MEO_Environment_Service_JWT": [] } ] } }, - "/private-networks/{privateNetworkId}/connections/vpns": { + "/environments/{environmentId}/site-instances": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { - "summary": "Add a new VPN to an existing private network", - "operationId": "addVpnToPrivateNetwork", - "description": "Adds a new VPN to the connections block of an existing private network", - "x-cli-name": "private-networks:create-vpn", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "tags": [ - "Private Networks" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_VPN" - }, - "example": { - "name": "vpn2", - "gateway_ip": "10.10.20.20", - "routes": [ - "192.168.1.0/24", - "192.168.2.0/24" - ], - "tunnel1": { - "shared_key": "sharedKey3", - "internal_cidr": "192.2.1.0/24", - "ike_versions": "1", - "startup_action": "start", - "dpd_timeout_action": "stop" - }, - "tunnel2": { - "shared_key": "sharedKey4", - "internal_cidr": "192.2.2.0/24", - "ike_versions": "2", - "startup_action": "start", - "dpd_timeout_action": "stop" - } - } - } - } - }, + "operationId": "api_environments_environmentIdsite-instances_post", + "x-cli-name": "environments:site-instances:create", + "x-prerelease": true, + "tags": [], "responses": { - "202": { - "description": "VPN request accepted", + "201": { + "description": "Site instance creation started.", "content": { "application/hal+json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "VPN is being created", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns/2" + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Site instance for site_id:3fa85f64-5717-4562-b3fc-2c963f66afa6 creation started." }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns" + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/environments/d3f7270e-c45f-4801-9308-5e8afe84a323/site-instances" + } + } + } + } } } } @@ -44589,271 +45814,370 @@ } }, "400": { - "description": "Bad request", + "description": "Validation Error in request body.", "content": { - "application/hal+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_ValidationError" - }, - "example": { - "error": "validation_failed", - "message": { - "gateway_ip": "Invalid IP address format" + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "validation_failed" + }, + "message": { + "type": "string", + "example": "Invalid request body." + }, + "code": { + "type": "integer", + "example": 400 + } } } } } }, "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "get": { - "summary": "Get VPNs for a Private Network", - "operationId": "getAllVpnsFromPrivateNetwork", - "description": "Retrieves the VPN Connections for a Private Network.", - "x-cli-name": "private-networks:list-vpns", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Limit" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Offset" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Sort" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Filter" - } - ], - "tags": [ - "Private Networks" - ], - "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_VPNList" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - } - }, - "/private-networks/{privateNetworkId}/connections/vpns/{vpnId}": { - "get": { - "summary": "Retrieve a VPN for a Private Network.", - "operationId": "getVpnFromPrivateNetwork", - "description": "Retrieves a VPN for a Private Network by Private Network ID and VPN ID.", - "x-cli-name": "private-networks:find-vpn", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_VpnId" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "tags": [ - "Private Networks" - ], - "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_Vpn" + "description": "Authorization required.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "system" + }, + "message": { + "type": "string", + "example": "Full authentication is required to access this resource." + }, + "code": { + "type": "integer", + "example": 401 + } + } + } + } + } }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + "403": { + "description": "Access Denied", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "forbidden" + }, + "message": { + "type": "string", + "example": "The site instance already exists." + }, + "code": { + "type": "integer", + "example": 403 + } + } + } + } + } }, "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + "description": "not found.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "not_found" + }, + "message": { + "type": "string", + "example": "Not Found." + }, + "code": { + "type": "integer", + "example": 404 + } + } + } + } + } }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + "422": { + "description": "Unprocessable entity" } }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "put": { - "summary": "Create or update a VPN for a Private Network.", - "operationId": "updateVpnInPrivateNetwork", - "description": "Creates a new VPN or updates an existing VPN for a Private Network by Private Network ID and VPN ID.", - "x-cli-name": "private-networks:update-vpn", + "summary": "Associate a site with an environment.", + "description": "Associate a site with an environment.", "parameters": [ { - "$ref": "#/components/parameters/Private_Network_Service_API_VpnId" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + "name": "environmentId", + "in": "path", + "description": "Environment unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], - "tags": [ - "Private Networks" - ], "requestBody": { - "required": true, + "description": "The new SiteInstance resource", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_VPN" - }, - "example": { - "name": "vpn1", - "gateway_ip": "10.10.10.11", - "routes": [ - "127.0.0.1/32", - "127.0.0.2/32", - "192.168.3.0/24" - ], - "tunnel1": { - "shared_key": "updatedSharedKey1", - "internal_cidr": "192.1.1.0/24", - "ike_versions": "1", - "startup_action": "start", - "dpd_timeout_action": "stop" - }, - "tunnel2": { - "shared_key": "updatedSharedKey2", - "internal_cidr": "192.1.2.0/24", - "ike_versions": "2", - "startup_action": "start", - "dpd_timeout_action": "stop" + "type": "object", + "properties": { + "site_id": { + "type": "string", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } } } } - } + }, + "required": false }, + "deprecated": false, + "security": [ + { + "MEO_Environment_Service_JWT": [] + } + ] + } + }, + "/site-instances/{siteId}.{environmentId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "get": { + "operationId": "site_instance", + "x-cli-name": "site-instances:find", + "x-prerelease": true, + "tags": [], "responses": { - "202": { - "description": "VPN request accepted", + "200": { + "description": "Site Instance details", "content": { "application/hal+json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "examples": { - "creation": { - "summary": "VPN creation response", - "description": "Response when creating a new VPN", - "value": { - "_links": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { "self": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections/vpns/1" + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/3e8ecbec-ea7c-4260-8414-ef2938c859bc.d3f7270e-c45f-4801-9308-5e8afe84a323" + } + } } - }, - "message": "The VPN is being created." - } - }, - "update": { - "summary": "VPN update response", - "description": "Response when updating an existing VPN", - "value": { - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections/vpns/1" + } + }, + "site_id": { + "type": "string", + "example": "3e8ecbec-ea7c-4260-8414-ef2938c859bc" + }, + "environment_id": { + "type": "string", + "example": "d3f7270e-c45f-4801-9308-5e8afe84a323" + }, + "status": { + "type": "string", + "example": "active" + }, + "health_status": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "OK" + }, + "summary": { + "type": "string", + "example": "The health status is OK." + }, + "details": { + "type": "string", + "example": "The site instance is active" } + } + }, + "domains": { + "type": "array", + "items": { + "type": "string", + "example": "example.com" }, - "message": "The VPN is being updated." + "example": [ + "example.com", + "example-2.com" + ] } } } } } }, - "400": { - "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" - }, "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + "description": "Authorization required.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "system" + }, + "message": { + "type": "string", + "example": "Full authentication is required to access this resource." + }, + "code": { + "type": "integer", + "example": 401 + } + } + } + } + } }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + "403": { + "description": "Access Denied", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "forbidden" + }, + "message": { + "type": "string", + "example": "Access Denied." + }, + "code": { + "type": "integer", + "example": 403 + } + } + } + } + } }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + "404": { + "description": "Site Instance not found.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "not_found" + }, + "message": { + "type": "string", + "example": "Not Found." + }, + "code": { + "type": "integer", + "example": 404 + } + } + } + } + } } }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "delete": { - "summary": "Delete a VPN for a Private Network.", - "operationId": "deleteVpnFromPrivateNetwork", - "description": "Deletes a VPN for a Private Network by Private Network ID and VPN ID.", - "x-cli-name": "private-networks:delete-vpn", + "summary": "Retrieves details about an environment association with a site (a site instance).", + "description": "Retrieves details about an environment association with a site (a site instance).", "parameters": [ { - "$ref": "#/components/parameters/Private_Network_Service_API_VpnId" + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false }, { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + "name": "environmentId", + "in": "path", + "description": "Environment unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], - "tags": [ - "Private Networks" - ], + "deprecated": false, + "security": [ + { + "MEO_Environment_Service_JWT": [] + } + ] + }, + "delete": { + "operationId": "api_site-instances_siteId._environmentId_delete", + "x-prerelease": true, + "tags": [], "responses": { "202": { - "description": "VPN removed successfully", + "description": "Site Instance deleted", "content": { "application/hal+json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "The VPN is being deleted.", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns/1" + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Site instance deletion started." }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000" + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/d3f7270e-c45f-4801-9308-5e8afe84a323.e3f7270e-c45f-4801-9308-5e8afe84a323" + } + } + } + } } } } @@ -44861,666 +46185,523 @@ } }, "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - } - }, - "/private-networks/{privateNetworkId}/connections/vpc-peers": { - "post": { - "summary": "Add a new VPC Peer to an existing private network", - "operationId": "addVpcPeerToPrivateNetwork", - "description": "Adds a new VPC Peer to the connections block of an existing private network", - "x-cli-name": "private-networks:create-vpc-peer", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "tags": [ - "Private Networks" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_VPCPeers" - }, - "example": { - "name": "vpcPeer2", - "aws_account": "123456789012", - "vpc_id": "vpc-1234567890abcdef0", - "vpc_cidr": "120.24.16.1/24" + "description": "Authorization required.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "system" + }, + "message": { + "type": "string", + "example": "Full authentication is required to access this resource." + }, + "code": { + "type": "integer", + "example": 401 + } + } + } } } - } - }, - "responses": { - "202": { - "description": "VPC Peer request accepted", + }, + "403": { + "description": "Access Denied", "content": { - "application/hal+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "VPC Peer is being created", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers/2" + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "forbidden" }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers" + "message": { + "type": "string", + "example": "Access Denied." + }, + "code": { + "type": "integer", + "example": 403 } } } } } }, - "400": { - "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "get": { - "summary": "Get VPC Peers for a Private Network", - "operationId": "getAllVpcPeersFromPrivateNetwork", - "description": "Retrieves the VPC Peers for a Private Network.", - "x-cli-name": "private-networks:list-vpc-peers", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Limit" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Offset" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Sort" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Filter" - } - ], - "tags": [ - "Private Networks" - ], - "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_VpcPeerList" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + "description": "Site Instance not found.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "not_found" + }, + "message": { + "type": "string", + "example": "Not Found." + }, + "code": { + "type": "integer", + "example": 404 + } + } + } + } + } } }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - } - }, - "/private-networks/{privateNetworkId}/connections/vpc-peers/{vpcPeerId}": { - "get": { - "summary": "Get a specific VPC Peer from a private network", - "operationId": "getVpcPeerFromPrivateNetwork", - "description": "Retrieves details of a specific VPC Peer from a private network", - "x-cli-name": "private-networks:find-vpc-peer", + "summary": "Dissociate a site and environment with no grace period.", + "description": "Dissociate a site and environment with no grace period.", "parameters": [ { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false }, { - "$ref": "#/components/parameters/Private_Network_Service_API_VpcPeerId" + "name": "environmentId", + "in": "path", + "description": "Environment unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], - "tags": [ - "Private Networks" - ], - "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_VpcPeer" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, + "deprecated": false, "security": [ { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] + "MEO_Environment_Service_JWT": [] } ] - }, - "delete": { - "summary": "Delete a VPC Peer for a Private Network.", - "operationId": "deleteVpcPeerFromPrivateNetwork", - "description": "Deletes a VPC Peer for a Private Network by Private Network ID and VPC Peer name.", - "x-cli-name": "private-networks:delete-vpc-peer", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_VpcPeerId" - } - ], - "tags": [ - "Private Networks" - ], + } + }, + "/site-instances/{siteId}.{environmentId}/actions/cancel": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "post": { + "operationId": "api_site-instances_siteId._environmentIdactionscancel_post", + "x-cli-name": "site-instances:dissociate", + "x-prerelease": true, + "tags": [], "responses": { "202": { - "description": "VPC Peer removed successfully", + "description": "Site Instance deleted", "content": { "application/hal+json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "The VPC Peer is being deleted.", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers/1" + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Site instance deletion started." }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000" + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site-instances/d3f7270e-c45f-4801-9308-5e8afe84a323.e3f7270e-c45f-4801-9308-5e8afe84a323" + } + } + } + } } } } } } }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + "400": { + "description": "Invalid input" }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - } - }, - "/private-networks/{privateNetworkId}/connections": { - "put": { - "summary": "Update Connections for a Private Network.", - "operationId": "updatePrivateNetworkConnections", - "description": "Updates the Connections configuration for a Private Network by Private Network ID.", - "x-cli-name": "private-networks:update-connections", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "tags": [ - "Private Networks" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_UpdateConnectionRequestSpec" - }, - "example": { - "private_egress_access": { - "drupal": true + "401": { + "description": "Authorization required.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "system" + }, + "message": { + "type": "string", + "example": "Full authentication is required to access this resource." + }, + "code": { + "type": "integer", + "example": 401 + } + } } } } - } - }, - "responses": { - "202": { - "description": "Connections updated", + }, + "403": { + "description": "Access Denied", "content": { - "application/hal+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "Private network connections update is in progress", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections" + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "forbidden" }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" + "message": { + "type": "string", + "example": "Access Denied." + }, + "code": { + "type": "integer", + "example": 403 } } } } } }, - "400": { - "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" + "description": "Site Instance not found.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "not_found" + }, + "message": { + "type": "string", + "example": "Not Found." + }, + "code": { + "type": "integer", + "example": 404 + } + } + } + } + } }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + "422": { + "description": "Unprocessable entity" } }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "get": { - "summary": "Get Connections for a Private Network.", - "operationId": "getPrivateNetworkConnections", - "x-cli-name": "private-networks:get-connections", + "summary": "Dissociate a site and environment.", + "description": "Dissociate a site and environment.", "parameters": [ { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + }, + { + "name": "environmentId", + "in": "path", + "description": "Environment unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], - "description": "Retrieves the Connections block for a Private Network, including VPNs and VPC Peers.", - "tags": [ - "Private Networks" - ], - "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_Connection" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + "requestBody": { + "description": "The new SiteInstance resource", + "content": { + "application/hal+json": { + "schema": { + "$ref": "#/components/schemas/MEO_Environment_Service_SiteInstance.jsonhal" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MEO_Environment_Service_SiteInstance" + } + }, + "text/html": { + "schema": { + "$ref": "#/components/schemas/MEO_Environment_Service_SiteInstance" + } + } }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } + "required": true }, + "deprecated": false, "security": [ { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] + "MEO_Environment_Service_JWT": [] } ] } }, - "/private-networks/{privateNetworkId}/isolation": { - "get": { - "summary": "Get Isolation for a Private Network.", - "operationId": "getPrivateNetworkIsolation", - "description": "Retrieves the Isolation configuration for a Private Network.", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "x-cli-name": "private-networks:get-isolation", - "tags": [ - "Private Networks" - ], + "/site-instances/{siteId}.{environmentId}/files": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "post": { + "operationId": "api_site-instances_siteId._environmentIdfiles_post", + "x-cli-name": "site-instances:files:copy", + "x-prerelease": true, + "tags": [], "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_Isolation" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" + "202": { + "description": "Copy files from one environment to another", + "content": { + "application/hal+json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Files copy for site id 3fa85f64-5717-4562-b3fc-2c9699999999 from 3fa85f64-5717-4562-b3fc-2c963f66afa6 to 4fa85f64-5717-4562-b3fc-2c963f66afa3 started." + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "string", + "example": "https://cloud.acquia.com/api/site/3fa85f64-5717-4562-b3fc-2c9699999999/files" + } + } + } + } + } + } + } + } + } }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + "400": { + "description": "Validation Error in request body.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "validation_failed" + }, + "message": { + "type": "string", + "example": "Invalid request body." + }, + "code": { + "type": "integer", + "example": 400 + } + } + } + } + } }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "put": { - "summary": "Update isolation settings of a private network", - "operationId": "updatePrivateNetworkIsolation", - "description": "Updates the isolation settings of a private network", - "tags": [ - "Private Networks" - ], - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "x-cli-name": "private-networks:update-isolation", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Isolation" - }, - "example": { - "dedicated_compute": true, - "dedicated_network": true + "401": { + "description": "Authorization required.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "system" + }, + "message": { + "type": "string", + "example": "Full authentication is required to access this resource." + }, + "code": { + "type": "integer", + "example": 401 + } + } + } } } - } - }, - "responses": { - "202": { - "description": "Isolation settings updated", + }, + "403": { + "description": "Access Denied", "content": { - "application/hal+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "Private network isolation settings have been updated successfully.", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/isolation" + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "forbidden" + }, + "message": { + "type": "string", + "example": "Access Denied." }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" + "code": { + "type": "integer", + "example": 403 } } } } } }, - "400": { - "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } - }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - } - }, - "/private-networks/{privateNetworkId}/ingress": { - "put": { - "summary": "Update Ingress for a Private Network.", - "operationId": "updatePrivateNetworkIngress", - "x-cli-name": "private-networks:update-ingress", - "description": "Updates the Ingress configuration for a Private Network by Private Network ID. Ingress always exists for a Private Network.", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "tags": [ - "Private Networks" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Ingress" - }, - "example": { - "drupal_ssh": { - "ingress_acls": [ - "test-acls" - ], - "private": true - } - } - } - } - }, - "responses": { - "202": { - "description": "Ingress settings updated", + "description": "not found.", "content": { - "application/hal+json": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_Message" - }, - "example": { - "message": "Private network ingress settings have been updated successfully.", - "_links": { - "self": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/ingress" + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "not_found" }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" + "message": { + "type": "string", + "example": "Not Found." + }, + "code": { + "type": "integer", + "example": 404 } } } } } }, - "400": { - "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" - }, - "409": { - "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" - }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + "422": { + "description": "Unprocessable entity" } }, - "security": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - }, - "get": { - "summary": "Get Ingress for a Private Network", - "operationId": "getIngressFromPrivateNetwork", - "x-cli-name": "private-networks:get-ingress", - "description": "Retrieves the Ingress configuration for a Private Network.", + "summary": "Copy files from one environment to another.", + "description": "Copy files from one environment to another.", "parameters": [ { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" + "name": "environmentId", + "in": "path", + "description": "Environment unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false + }, + { + "name": "siteId", + "in": "path", + "description": "Site unique identifier", + "required": true, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string" + }, + "style": "simple", + "explode": false, + "allowReserved": false } ], - "tags": [ - "Private Networks" - ], - "responses": { - "200": { - "$ref": "#/components/responses/Private_Network_Service_API_Ingress" - }, - "401": { - "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" - }, - "404": { - "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" + "requestBody": { + "description": "The new SiteInstance resource", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "source_environment_id": { + "type": "string", + "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" + } + } + } + } }, - "500": { - "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" - } + "required": false }, + "deprecated": false, "security": [ { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] + "MEO_Environment_Service_JWT": [] } ] } }, - "/codebases/{codebaseId}/sites": { - "get": { - "operationId": "api_codebases_codebaseIdsites_get_collection", - "x-cli-name": "codebases:sites-list", + "/v3/environments/{environmentId}/actions/clear-caches": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], + "post": { + "operationId": "postV3EnvironmentsClearCaches", + "x-cli-name": "environments-v3:clear-caches", "x-prerelease": true, "tags": [], "responses": { - "200": { - "description": "A list of sites associated with a codebase.", + "202": { + "description": "Domains cache flush started.", "content": { "application/hal+json": { "schema": { "type": "object", "properties": { - "count": { - "type": "integer", - "example": 1 - }, - "total": { - "type": "integer", - "example": 1 - }, - "pagination": { - "type": "object", - "properties": { - "total": { - "type": "integer", - "example": 1 - }, - "limit": { - "type": "integer", - "example": 25 - }, - "offset": { - "type": "integer", - "example": 1 - } - } - }, - "_embedded": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/codebases/1234-5678/sites/8979a8ac-80dc-4df8-b2f0-6be36554a370" - } - } - } - } - }, - "id": { - "type": "string", - "example": "8979a8ac-80dc-4df8-b2f0-6be36554a370" - }, - "name": { - "type": "string", - "example": "site2" - }, - "label": { - "type": "string", - "example": "My Site 2" - }, - "description": { - "type": "string", - "example": "My Site 2 description" - }, - "codebase_id": { - "type": "string", - "example": "1234-5678" - } - } - } - } - } - }, "_links": { "type": "object", "properties": { @@ -45529,60 +46710,67 @@ "properties": { "href": { "type": "string", - "example": "https://cloud.acquia.com/api/codebases/1234-5678/sites?limit=25&offset=1" - } - } - }, - "limit": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/codebases/1234-5678/sites?offset=1{&limit}", - "format": "uri-template" - } - } - }, - "offset": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/codebases/1234-5678/sites?limit=25{&offset}", - "format": "uri-template" - } - } - }, - "filter": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/codebases/1234-5678/sites?limit=25&offset=1{&filter}", - "format": "uri-template" - } - } - }, - "sort": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/codebases/1234-5678/sites?limit=25&offset=1{&sort}", - "format": "uri-template" - } - } - }, - "prev": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/codebases/1234-5678/sites?limit=25&offset=1" + "format": "uri", + "example": "https://cloud.acquia.com/api/environments/3e8ecbec-ea7c-4260-8414-ef2938c859bc/actions/clear-caches" } } } } + }, + "message": { + "type": "string", + "example": "Varnish domain cache clear started." + } + } + } + } + } + }, + "400": { + "description": "Invalid input" + }, + "401": { + "description": "Authorization required.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "system" + }, + "message": { + "type": "string", + "example": "Full authentication is required to access this resource." + }, + "code": { + "type": "integer", + "example": 401 + } + } + } + } + } + }, + "403": { + "description": "Access Denied", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "example": "forbidden" + }, + "message": { + "type": "string", + "example": "Access Denied." + }, + "code": { + "type": "integer", + "example": 403 } } } @@ -45590,7 +46778,7 @@ } }, "404": { - "description": "Codebase sites not found.", + "description": "Domain not found.", "content": { "application/json": { "schema": { @@ -45602,7 +46790,11 @@ }, "message": { "type": "string", - "example": "The codebase you are trying to access does not exist, or you do not have permission to access it." + "example": "The domain provided does not exist." + }, + "code": { + "type": "integer", + "example": 404 } } } @@ -45610,13 +46802,13 @@ } } }, - "summary": "Retrieves a list of sites associated with a codebase.", - "description": "Retrieves a list of site associated with a codebase.", + "summary": "Clear caches for an environment with a list of domains.", + "description": "Clear caches for an environment with a list of domains.", "parameters": [ { - "name": "codebaseId", + "name": "environmentId", "in": "path", - "description": "The codebase entity's unique identifier.", + "description": "Environment unique identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -45626,48 +46818,52 @@ "style": "simple", "explode": false, "allowReserved": false - }, - { - "name": "offset", - "in": "query", - "description": "The collection page number", - "required": false, - "deprecated": false, - "allowEmptyValue": true, - "schema": { - "type": "integer", - "default": 1 - }, - "style": "form", - "explode": false, - "allowReserved": false - }, - { - "name": "limit", - "in": "query", - "description": "The number of items per page", - "required": false, - "deprecated": false, - "allowEmptyValue": true, - "schema": { - "type": "integer", - "default": 25, - "minimum": 0 - }, - "style": "form", - "explode": false, - "allowReserved": false } ], + "requestBody": { + "description": "List of domains.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "domains": { + "type": "array", + "items": { + "type": "string", + "example": "example.com" + } + } + }, + "required": [ + "domains" + ] + }, + "example": { + "domains": [ + "example.com", + "another-domain.com" + ] + } + } + }, + "required": false + }, "deprecated": false, "security": [ { - "Site_Service_JWT": [] + "MEO_Environment_Service_JWT": [] } ] } }, "/environments/{environmentId}/sites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "operationId": "api_environments_environmentIdsites_get_collection", "x-cli-name": "environments:sites-list", @@ -45912,6 +47108,12 @@ } }, "/subscriptions/{subscriptionId}/sites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "operationId": "api_subscriptions_subscriptionIdsites_get_collection", "tags": [], @@ -46093,6 +47295,12 @@ } }, "/sites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "operationId": "get_sites", "x-cli-name": "sites:list", @@ -46422,6 +47630,12 @@ } }, "/sites/{siteId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "operationId": "get_site_by_id", "x-cli-name": "sites:find", @@ -46954,7 +48168,7 @@ "Acquia_Cloud_API_Documentation_resolution": { "name": "resolution", "in": "query", - "description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for “minute” resolution\n- 1 week limit for “hour” resolution\n- 6 month limit for “day” resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for “month” resolution\n", + "description": "Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.\n\nLimits:\n- 3 hour limit for \u201cminute\u201d resolution\n- 1 week limit for \u201chour\u201d resolution\n- 6 month limit for \u201cday\u201d resolution\n- 1 year limit for \"week\" resolution\n- 3 year limit for \u201cmonth\u201d resolution\n", "required": false, "schema": { "type": "string", @@ -47016,7 +48230,7 @@ "schema": { "type": "string" }, - "example": "2019-10-01T00:00:00.000Z" + "example": "2019-10-01" }, "Acquia_Cloud_API_Documentation_deprecated-to": { "name": "to", @@ -47027,7 +48241,7 @@ "schema": { "type": "string" }, - "example": "2020-01-01T00:00:00.000Z" + "example": "2020-01-01" }, "Acquia_Cloud_API_Documentation_backup-id": { "name": "backupId", @@ -47099,7 +48313,7 @@ "schema": { "type": "string" }, - "example": "2021-01-29T22:45:21.000Z" + "example": "2021-01-29T22:45:21+00:00" }, "Acquia_Cloud_API_Documentation_to-no-default": { "name": "to", @@ -47109,7 +48323,7 @@ "schema": { "type": "string" }, - "example": "2021-01-29T23:55:21.000Z" + "example": "2021-01-29T23:55:21+00:00" }, "Acquia_Cloud_API_Documentation_index-id": { "name": "indexId", @@ -47352,7 +48566,7 @@ "schema": { "type": "string" }, - "example": "2021-01-29T22:45:21.000Z" + "example": "2021-01-29T22:45:21+00:00" }, "Acquia_Cloud_API_Documentation_ApmType": { "$ref": "#/components/parameters/Acquia_Cloud_API_Documentation_apm-type" @@ -52370,6 +53584,23 @@ }, "flags": { "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_eip-flags" + }, + "_links": { + "type": "object", + "description": "HAL links for this Web EIP.", + "properties": { + "self": { + "type": "object", + "description": "A link to this resource.", + "properties": { + "href": { + "type": "string", + "format": "uri", + "description": "The URI for this Web EIP." + } + } + } + } } } }, @@ -52378,10 +53609,60 @@ "properties": { "total": { "type": "integer", - "description": "The number of items returned in the collection." + "description": "The total number of items in the collection." + }, + "count": { + "type": "integer", + "description": "The number of items returned in the current result set." }, "_links": { - "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_links" + "allOf": [ + { + "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_links" + }, + { + "type": "object", + "properties": { + "parent": { + "type": "object", + "description": "A link to the parent environment resource.", + "properties": { + "href": { + "type": "string", + "format": "uri", + "description": "The URI of the parent environment." + } + } + }, + "limit": { + "type": "object", + "description": "A templated link to apply a limit to the collection.", + "properties": { + "href": { + "type": "string", + "description": "The URI template for applying a limit." + }, + "templated": { + "type": "boolean" + } + } + }, + "offset": { + "type": "object", + "description": "A templated link to apply an offset to the collection.", + "properties": { + "href": { + "type": "string", + "description": "The URI template for applying an offset." + }, + "templated": { + "type": "boolean" + } + } + } + } + } + ] }, "_embedded": { "type": "object", @@ -60313,6 +61594,10 @@ "vpc_cidr": { "type": "string", "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}/[0-9]{1,2}$" + }, + "region": { + "type": "string", + "description": "The region where the VPC Peer is deployed" } } }, @@ -60339,6 +61624,10 @@ "type": "string", "description": "The ID of the peering connection (optional)" }, + "region": { + "type": "string", + "description": "The region where the VPC Peer is deployed (optional)" + }, "_links": { "$ref": "#/components/schemas/Private_Network_Service_API_HalItem" } @@ -60683,6 +61972,18 @@ "codebase_id": { "$ref": "#/components/schemas/Site_Service_CodebaseId" }, + "status": { + "type": "string", + "enum": [ + "SITE_STATUS_UNSPECIFIED", + "SITE_STATUS_READY", + "SITE_STATUS_MARKED_FOR_DELETION" + ] + }, + "delete_at": { + "type": "integer", + "nullable": true + }, "_links": { "type": "array", "items": { @@ -60764,6 +62065,18 @@ }, "codebase_id": { "$ref": "#/components/schemas/Site_Service_CodebaseId.jsonhal" + }, + "status": { + "type": "string", + "enum": [ + "SITE_STATUS_UNSPECIFIED", + "SITE_STATUS_READY", + "SITE_STATUS_MARKED_FOR_DELETION" + ] + }, + "delete_at": { + "type": "integer", + "nullable": true } } }, @@ -61118,8 +62431,8 @@ "description": "Private network for NGC", "label": "ngc-private", "status": "active", - "created_at": "2023-10-01T12:00:00.000Z", - "updated_at": "2023-10-01T12:00:00.000Z" + "created_at": "2023-10-01T12:00:00Z", + "updated_at": "2023-10-01T12:00:00Z" } } } @@ -61194,7 +62507,8 @@ "aws_account": "123456789012", "vpc_id": "vpc-1234567890abcdef0", "vpc_cidr": "120.24.16.1/24", - "peering_connection_id": "pcx-1234567890abcdef0" + "peering_connection_id": "pcx-1234567890abcdef0", + "region": "eu-central-1" } } } @@ -61315,8 +62629,8 @@ "name": "test-private-network-1", "label": "some label", "description": "Private network description", - "created_at": "2021-01-01T00:00:00.000Z", - "updated_at": "2021-01-01T00:00:00.000Z", + "created_at": "2021-01-01T00:00:00Z", + "updated_at": "2021-01-01T00:00:00Z", "_links": { "self": { "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" @@ -61331,8 +62645,8 @@ "name": "test-private-network-2", "label": "some label", "description": "Private network description", - "created_at": "2021-01-01T00:00:00.000Z", - "updated_at": "2021-01-01T00:00:00.000Z", + "created_at": "2021-01-01T00:00:00Z", + "updated_at": "2021-01-01T00:00:00Z", "_links": { "self": { "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174001" @@ -61441,14 +62755,16 @@ "name": "vpcPeer1", "aws_account": "123456789012", "vpc_id": "vpc-1234567890abcdef0", - "vpc_cidr": "10.0.0.0/16" + "vpc_cidr": "10.0.0.0/16", + "region": "eu-central-1" }, { "id": 2, "name": "vpcPeer2", "aws_account": "123456789012", "vpc_id": "vpc-1234567890abcdef0", - "vpc_cidr": "10.0.0.0/16" + "vpc_cidr": "10.0.0.0/16", + "region": "eu-central-1" } ] } @@ -61548,7 +62864,8 @@ "name": "vpcPeer1", "aws_account": "123456789012", "vpc_id": "vpc-1234567890abcdef0", - "vpc_cidr": "120.24.16.1/24" + "vpc_cidr": "120.24.16.1/24", + "region": "eu-central-1" } ] } diff --git a/assets/acquia-spec.version b/assets/acquia-spec.version index 53abcbac2..6c9d5c7c9 100644 --- a/assets/acquia-spec.version +++ b/assets/acquia-spec.version @@ -1 +1 @@ -c1a6c6733a1ec7a8d3344cc2a2390f694ab73335 +c43c24c3f962a0ef98f6b79b9c80e5d8eb86b740 diff --git a/tests/phpunit/src/Commands/Api/ApiCommandTest.php b/tests/phpunit/src/Commands/Api/ApiCommandTest.php index 5defe3002..30675217c 100644 --- a/tests/phpunit/src/Commands/Api/ApiCommandTest.php +++ b/tests/phpunit/src/Commands/Api/ApiCommandTest.php @@ -553,7 +553,7 @@ public static function providerTestApiCommandDefinitionRequestBody(): array [ 'api:private-networks:create', 'post', - ['api:private-networks:create \'123e4567-e89b-12d3-a456-426614174000\' \'us-east-1\' \'customer-private-network\' --description=\'Private network for customer\' --label=\'anyLabel\' --isolation=\'{"dedicated_compute":false,"dedicated_network":false}\' --ingress=\'{"drupal_ssh":{"ingress_acls":["test-acls"]}}\' \'{"cidr":"114.7.55.1\/16","private_egress_access":{"drupal":true},"vpns":[{"name":"vpn1","gateway_ip":"10.10.10.10","routes":["127.0.0.1\/32","127.0.0.2\/32"],"tunnel1":{"shared_key":"sharedKey1","internal_cidr":"192.1.1.0\/24","ike_versions":"1","startup_action":"start","dpd_timeout_action":"stop"},"tunnel2":{"shared_key":"sharedKey2","internal_cidr":"192.1.1.0\/14","ike_versions":"1","startup_action":"start","dpd_timeout_action":"stop"}}],"vpc_peers":[{"name":"vpcPeer1","aws_account":"123456789012","vpc_id":"vpc-1234567890abcdef0","vpc_cidr":"120.24.16.1\/24"}]}\''], + ['api:private-networks:create \'123e4567-e89b-12d3-a456-426614174000\' \'us-east-1\' \'customer-private-network\' --description=\'Private network for customer\' --label=\'anyLabel\' --isolation=\'{"dedicated_compute":false,"dedicated_network":false}\' --ingress=\'{"drupal_ssh":{"ingress_acls":["test-acls"]}}\' \'{"cidr":"114.7.55.1\/16","private_egress_access":{"drupal":true},"vpns":[{"name":"vpn1","gateway_ip":"10.10.10.10","routes":["127.0.0.1\/32","127.0.0.2\/32"],"tunnel1":{"shared_key":"sharedKey1","internal_cidr":"192.1.1.0\/24","ike_versions":"1","startup_action":"start","dpd_timeout_action":"stop"},"tunnel2":{"shared_key":"sharedKey2","internal_cidr":"192.1.1.0\/14","ike_versions":"1","startup_action":"start","dpd_timeout_action":"stop"}}],"vpc_peers":[{"name":"vpcPeer1","aws_account":"123456789012","vpc_id":"vpc-1234567890abcdef0","vpc_cidr":"120.24.16.1\/24","region":"eu-central-1"}]}\''], ], [ 'api:private-networks:update-isolation', diff --git a/tests/phpunit/src/TestBase.php b/tests/phpunit/src/TestBase.php index 626510530..915b552fb 100644 --- a/tests/phpunit/src/TestBase.php +++ b/tests/phpunit/src/TestBase.php @@ -317,8 +317,12 @@ public static function getMockResponseFromSpec(mixed $path, mixed $method, mixed protected function getPathMethodCodeFromSpec(string $operationId): array { $acquiaCloudSpec = self::getCloudApiSpec(); + $httpMethods = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']; foreach ($acquiaCloudSpec['paths'] as $path => $methodEndpoint) { foreach ($methodEndpoint as $method => $endpoint) { + if (!in_array($method, $httpMethods, true) || !isset($endpoint['operationId'])) { + continue; + } if ($endpoint['operationId'] === $operationId) { foreach ($endpoint['responses'] as $code => $response) { if ($code >= 200 && $code < 300) {