diff --git a/assets/acquia-spec.json b/assets/acquia-spec.json index ff81ebda9..44545a6f3 100644 --- a/assets/acquia-spec.json +++ b/assets/acquia-spec.json @@ -7,23 +7,13 @@ "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)", "url": "https://www.acquia.com" } }, - "servers": [ - { - "url": "https://cloud.acquia.com/api", - "description": "Cloud API" - }, - { - "url": "/", - "description": "" - } - ], "tags": [ { "name": "Current system health", @@ -105,6 +95,12 @@ ], "paths": { "/": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Current system health" @@ -162,6 +158,12 @@ } }, "/account": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -185,7 +187,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 +275,12 @@ } }, "/account/applications/{applicationUuid}/has-permission": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -362,6 +370,12 @@ } }, "/account/applications/{applicationUuid}/is-admin": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -442,6 +456,12 @@ } }, "/account/applications/{applicationUuid}/is-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -504,6 +524,12 @@ } }, "/account/applications/{applicationUuid}/actions/mark-recent": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Account" @@ -580,6 +606,12 @@ } }, "/account/applications/{applicationUuid}/actions/star": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Account" @@ -662,6 +694,12 @@ } }, "/account/applications/{applicationUuid}/actions/unstar": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Account" @@ -744,6 +782,12 @@ } }, "/account/drush-aliases/download": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -826,6 +870,12 @@ } }, "/account/ides": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -920,6 +970,12 @@ } }, "/account/invites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1004,7 +1060,7 @@ }, "uuid": "eb947b2c-2fe0-11e9-b210-d663bd873d93", "email": "invitee@example.com", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "token": "dd9ea69fdcb6bee08b31a858b85535ec", "flags": { "declined": false @@ -1033,7 +1089,7 @@ }, "uuid": "0540f4ba-2fe1-11e9-b210-d663bd873d93", "email": "invitee@example.com", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "token": "dd9ea69fdcb6bee08b31a858b85535ec", "flags": { "declined": false @@ -1075,6 +1131,12 @@ } }, "/account/messages": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1166,8 +1228,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 +1259,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 +1301,12 @@ } }, "/account/organizations/{organizationUuid}/is-admin": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1319,6 +1387,12 @@ } }, "/account/organizations/{organizationUuid}/is-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1381,6 +1455,12 @@ } }, "/account/password": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Account" @@ -1433,6 +1513,12 @@ } }, "/account/ssh-keys": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1502,7 +1588,7 @@ "uuid": "02905393-65d7-4bef-873b-24593f73d273", "label": "PC Home", "fingerprint": "5d:23:fb:45:70:df:ef:ad:ca:bf:81:93:cd:50:26:28", - "created_at": "2017-05-09T20:30:35.000Z", + "created_at": "2017-05-09T20:30:35+00:00", "public_key": "ssh-rsa AAAAB3NzaC1yc2EADHrfHY17SbrmAAABIwAAAQEAklOUpkTIpNLTGK9Tjom/BWDSUGPl+nafzlZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5HDTYW7hdI4yQVkbPppSwg0cda3Pbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com", "_links": { "self": { @@ -1514,7 +1600,7 @@ "uuid": "d40833b3-6ea4-4339-9e2c-4b78e700258b", "label": "Laptop Work", "fingerprint": "5b:18:fb:50:55:df:cf:d5:bf:ea:81:23:ef:55:22:29", - "created_at": "2017-05-09T20:30:35.000Z", + "created_at": "2017-05-09T20:30:35+00:00", "public_key": "ssh-rsa 1yc2EAAAABIwbrmTIpNLTGK9Tjom/BWDSUGPl+nafzlHDAAAQEAklOUpkDHrfHY17STYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4pSwg0cda3PbAAAAB3NzaCv7kOdJ/MTyBlWXFCRh9lFX5QVkbPp+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com", "_links": { "self": { @@ -1526,7 +1612,7 @@ "uuid": "c40ee264-0023-4f60-815b-d20b44740746", "label": "PC Work", "fingerprint": "7c:s3:ab:30:40:da:cf:c5:bf:ca:31:33:ed:58:23:21", - "created_at": "2017-05-09T20:30:35.000Z", + "created_at": "2017-05-09T20:30:35+00:00", "public_key": "ssh-rsa A1yc2EAAAlOUpkDHrfHY17SbrmTIAAAB3NzaCom/BWDSUGPl+nafzlHDTYW7hdI4yQVkbPppSwg0cda3ABIwAAAQEAkPZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5bv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XAt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/EnmZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbxNrRFi9wrf+M7Q== example@example.com", "_links": { "self": { @@ -1711,6 +1797,12 @@ } }, "/account/ssh-keys/{sshKeyUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1741,7 +1833,7 @@ "uuid": "b2a53dfb-f4e2-4543-814d-7a9aa3793746", "label": "PC Home", "fingerprint": "8d:13:fb:50:50:da:cf:c5:bf:ca:31:33:ed:51:27:24", - "created_at": "2017-05-09T20:30:35.000Z", + "created_at": "2017-05-09T20:30:35+00:00", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQChwPHzTTDKDpSbpa2+d22LcbQmsw92eLsUK3Fmei1fiGDkd34NsYCN8m7lsi3NbvdMS83CtPQPWiCveYPzFs1/hHc4PYj8opD2CNnr5iWVVbyaulCYHCgVv4aB/ojcexg8q483A4xJeF15TiCr/gu34rK6ucTvC/tn/rCwJBudczvEwt0klqYwv8Cl/ytaQboSuem5KgSjO3lMrb6CWtfSNhE43ZOw+UBFBqxIninN868vGMkIv9VY34Pwj54rPn/ItQd6Ef4B0KHHaGmzK0vfP+AK7FxNMoHnj3iYT33KZNqtDozdn5tYyH/bThPebEtgqUn+/w5l6wZIC/8zzvls/127ngHk+jNa0PlNyS2TxhPUK4NaPHIEnnrlp07JEYC4ImcBjaYCWAdcTcUkcJjwZQkN4bGmyO9cjICH98SdLD/HxqzTHeaYDbAX/Hu9HfaBb5dXLWsjw3Xc6hoVnUUZbMQyfgb0KgxDLh92eNGxJkpZiL0VDNOWCxDWsNpzwhLNkLqCvI6lyxiLaUzvJAk6dPaRhExmCbU1lDO2eR0FdSwC1TEhJOT9eDIK1r2hztZKs2oa5FNFfB/IFHVWasVFC9N2h/r/egB5zsRxC9MqBLRBq95NBxaRSFng6ML5WZSw41Qi4C/JWVm89rdj2WqScDHYyAdwyyppWU4T5c9Fmw== example@example.com", "_links": { "self": { @@ -1856,6 +1948,12 @@ } }, "/account/subscriptions/{subscriptionUuid}/is-admin": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1936,6 +2034,12 @@ } }, "/account/subscriptions/{subscriptionUuid}/is-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -1998,6 +2102,12 @@ } }, "/account/teams/{teamUuid}/has-permission": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2087,6 +2197,12 @@ } }, "/account/teams/{teamUuid}/is-admin": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2167,6 +2283,12 @@ } }, "/account/teams/{teamUuid}/is-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2229,6 +2351,12 @@ } }, "/account/tokens": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2402,6 +2530,12 @@ } }, "/account/tokens/{tokenUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Account" @@ -2555,6 +2689,12 @@ } }, "/agreements": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Agreements" @@ -2589,8 +2729,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 +2756,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 +2783,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 +2821,12 @@ } }, "/agreements/{agreementUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Agreements" @@ -2713,8 +2859,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 +2913,12 @@ } }, "/agreements/{agreementUuid}/actions/accept": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Agreements" @@ -2835,6 +2987,12 @@ } }, "/agreements/{agreementUuid}/actions/decline": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Agreements" @@ -2903,6 +3061,12 @@ } }, "/agreements/{agreementUuid}/invitees": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Agreements" @@ -2981,6 +3145,12 @@ } }, "/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3179,6 +3349,12 @@ } }, "/applications/{applicationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3491,6 +3667,12 @@ } }, "/applications/{applicationUuid}/artifacts": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3557,7 +3739,7 @@ "id": 1, "name": "master@e5a80b9e0a2bdb1df32c6cdfce54deb70cc20ad2", "state": "ready", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "_links": { "self": { "href": "https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1" @@ -3568,7 +3750,7 @@ "id": 2, "name": "master@a265389db6a6918cf4e51edbe5f06d7e1578175c", "state": "pending-upload", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "_links": { "self": { "href": "https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/2" @@ -3579,7 +3761,7 @@ "id": 3, "name": "master@e7157f36e5fb82317ffee2fc2d70302cdad0c60c", "state": "deleted", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "_links": { "self": { "href": "https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/3" @@ -3620,6 +3802,12 @@ } }, "/applications/{applicationUuid}/artifacts/{artifactId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3648,7 +3836,7 @@ "id": 1, "name": "master@e5a80b9e0a2bdb1df32c6cdfce54deb70cc20ad2", "state": "ready", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "_links": { "self": { "href": "https://cloud.acquia.com/api/applications/a47ac10b-58cc-4372-a567-0e02b2c3d470/artifacts/1" @@ -3701,6 +3889,12 @@ } }, "/applications/{applicationUuid}/code": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -3797,6 +3991,12 @@ } }, "/applications/{applicationUuid}/code-studio": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -4060,6 +4260,12 @@ } }, "/applications/{applicationUuid}/databases": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -4375,6 +4581,12 @@ } }, "/applications/{applicationUuid}/databases/{name}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "delete": { "tags": [ "Applications" @@ -4523,6 +4735,12 @@ } }, "/applications/{applicationUuid}/databases/{name}/actions/erase": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Applications" @@ -4669,6 +4887,12 @@ } }, "/applications/{applicationUuid}/email/domains": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -4805,6 +5029,12 @@ } }, "/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Applications" @@ -4925,6 +5155,12 @@ } }, "/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Applications" @@ -5051,6 +5287,12 @@ } }, "/applications/{applicationUuid}/ides": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -5107,8 +5349,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 +5380,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 +5546,12 @@ } }, "/applications/{applicationUuid}/messages": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -5384,8 +5632,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 +5663,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 +5705,12 @@ } }, "/applications/{applicationUuid}/notifications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -5528,8 +5782,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 +5839,12 @@ } }, "/applications/{applicationUuid}/permissions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6081,6 +6341,12 @@ } }, "/applications/{applicationUuid}/search": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6163,6 +6429,12 @@ } }, "/applications/{applicationUuid}/search/config-sets": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6472,6 +6744,12 @@ } }, "/applications/{applicationUuid}/search/config-sets/{configurationSetId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6677,6 +6955,12 @@ } }, "/applications/{applicationUuid}/settings": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6750,6 +7034,12 @@ } }, "/applications/{applicationUuid}/settings/hosting": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6833,6 +7123,12 @@ } }, "/applications/{applicationUuid}/settings/keys": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -6921,6 +7217,12 @@ } }, "/applications/{applicationUuid}/settings/ra": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -7040,8 +7342,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 +7359,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 +7526,12 @@ } }, "/applications/{applicationUuid}/settings/security": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -7476,6 +7784,12 @@ } }, "/applications/{applicationUuid}/tags": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -7702,6 +8016,12 @@ } }, "/applications/{applicationUuid}/tags/{tagName}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "delete": { "tags": [ "Applications" @@ -7770,6 +8090,12 @@ } }, "/applications/{applicationUuid}/tasks": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -7833,8 +8159,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 +8170,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 +8223,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 +8234,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 +8318,12 @@ } }, "/applications/{applicationUuid}/teams": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8101,6 +8433,12 @@ } }, "/applications/{applicationUuid}/metrics/usage": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8198,6 +8536,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/data": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8250,15 +8594,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 +8635,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 +8718,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/data-by-environment": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8499,15 +8849,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 +8888,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 +9029,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/{usageMetric}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8715,15 +9071,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 +9151,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/views-by-environment": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -8890,15 +9252,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 +9363,12 @@ } }, "/applications/{applicationUuid}/metrics/usage/visits-by-environment": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -9096,15 +9464,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 +9575,12 @@ } }, "/distributions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Distributions" @@ -9300,6 +9674,12 @@ } }, "/distributions/{name}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Distributions" @@ -9387,6 +9767,12 @@ } }, "/applications/{applicationUuid}/environments": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -9904,6 +10290,12 @@ } }, "/applications/{applicationUuid}/features": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Applications" @@ -9962,6 +10354,12 @@ } }, "/environments/{environmentId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -10573,6 +10971,12 @@ } }, "/environments/{environmentId}/actions/clear-caches": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -10697,6 +11101,12 @@ } }, "/environments/{environmentId}/actions/change-label": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -10847,6 +11257,12 @@ } }, "/environments/{environmentId}/artifacts/actions/switch": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -11026,6 +11442,12 @@ } }, "/environments/{environmentId}/operating-systems": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -11096,6 +11518,12 @@ } }, "/environments/{environmentId}/available-runtimes": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -11169,6 +11597,12 @@ } }, "/environments/{environmentId}/cdn": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -11441,6 +11875,12 @@ } }, "/environments/{environmentId}/cloud-actions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -11702,6 +12142,12 @@ } }, "/environments/{environmentId}/cloud-actions/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -11786,6 +12232,12 @@ } }, "/environments/{environmentId}/cloud-actions/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -11870,6 +12322,12 @@ } }, "/environments/{environmentId}/cloud-actions/actions/reset": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -11954,6 +12412,12 @@ } }, "/environments/{environmentId}/code": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -12124,6 +12588,12 @@ } }, "/environments/{environmentId}/code/actions/switch": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -12289,6 +12759,12 @@ } }, "/environments/{environmentId}/code/actions/import": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -12458,6 +12934,12 @@ } }, "/environments/{environmentId}/crons": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -12736,6 +13218,12 @@ } }, "/environments/{environmentId}/crons/{cronId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13084,6 +13572,12 @@ } }, "/environments/{environmentId}/crons/{cronId}/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -13200,6 +13694,12 @@ } }, "/environments/{environmentId}/crons/{cronId}/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -13316,6 +13816,12 @@ } }, "/environments/{environmentId}/databases": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13663,6 +14169,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13760,6 +14272,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/php-config": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13838,6 +14356,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/backups": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -13920,8 +14444,8 @@ "name": "db_name" }, "type": "daily", - "started_at": "2012-05-15T12:00:00.000Z", - "completed_at": "2012-05-15T12:00:00.000Z", + "started_at": "2012-05-15T12:00:00Z", + "completed_at": "2012-05-15T12:00:00Z", "flags": { "deleted": false }, @@ -13948,8 +14472,8 @@ "name": "db_name" }, "type": "daily", - "started_at": "2012-03-28T12:00:00.000Z", - "completed_at": "2012-03-28T12:00:01.000Z", + "started_at": "2012-03-28T12:00:00Z", + "completed_at": "2012-03-28T12:00:01Z", "flags": { "deleted": false }, @@ -13976,8 +14500,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 +14528,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 +14709,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -14219,8 +14749,8 @@ "name": "db_name" }, "type": "daily", - "started_at": "2012-05-15T12:00:00.000Z", - "completed_at": "2012-05-15T12:00:00.000Z", + "started_at": "2012-05-15T12:00:00Z", + "completed_at": "2012-05-15T12:00:00Z", "flags": { "deleted": false }, @@ -14432,6 +14962,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -14466,7 +15002,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 +15081,12 @@ } }, "/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -14686,6 +15228,12 @@ } }, "/environments/{environmentId}/dns": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -14798,6 +15346,12 @@ } }, "/environments/{environmentId}/domains": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -15115,6 +15669,12 @@ } }, "/environments/{environmentId}/domains/actions/clear-varnish": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -15240,6 +15800,12 @@ } }, "/environments/{environmentId}/domains/{domain}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -15422,6 +15988,12 @@ } }, "/environments/{environmentId}/domains/{domain}/actions/clear-varnish": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -15522,6 +16094,12 @@ } }, "/environments/{environmentId}/domains/{domain}/actions/clear-caches": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -15621,6 +16199,12 @@ } }, "/environments/{environmentId}/domains/{domain}/status": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -15703,6 +16287,12 @@ } }, "/environments/{environmentId}/eips": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -15726,12 +16316,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 +16344,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 +16379,12 @@ } }, "/environments/{environmentId}/email": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Email" @@ -15837,6 +16447,12 @@ } }, "/environments/{environmentId}/files": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -16021,6 +16637,12 @@ } }, "/environments/{environmentId}/logs": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -16218,6 +16840,12 @@ } }, "/environments/{environmentId}/logs/{logType}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -16251,7 +16879,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 +16975,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 +17106,12 @@ } }, "/environments/{environmentId}/logstream": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -16557,6 +17191,12 @@ } }, "/environments/{environmentId}/livedev/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -16733,6 +17373,12 @@ } }, "/environments/{environmentId}/livedev/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -16888,6 +17534,12 @@ } }, "/environments/{environmentId}/log-forwarding-destinations": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -16941,7 +17593,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 +17633,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 +18054,12 @@ } }, "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -17434,7 +18092,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 +18651,12 @@ } }, "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -18112,6 +18776,12 @@ } }, "/environments/{environmentId}/log-forwarding-destinations/{logForwardingDestinationUuid}/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -18263,6 +18933,12 @@ } }, "/environments/{environmentId}/metrics": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18345,6 +19021,12 @@ } }, "/environments/{environmentId}/metrics/stackmetrics": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18427,6 +19109,12 @@ } }, "/environments/{environmentId}/metrics/stackmetrics/data": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18490,7 +19178,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 +19199,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 +19220,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 +19241,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 +19292,12 @@ } }, "/environments/{environmentId}/metrics/usage": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18692,6 +19386,12 @@ } }, "/environments/{environmentId}/metrics/usage/data": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18744,15 +19444,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 +19483,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 +19564,12 @@ } }, "/environments/{environmentId}/metrics/usage/{usageMetric}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -18900,15 +19606,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 +19690,12 @@ } }, "/environments/{environmentId}/mod-proxy": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -19064,6 +19776,12 @@ } }, "/environments/{environmentId}/mod-proxy/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -19159,6 +19877,12 @@ } }, "/environments/{environmentId}/mod-proxy/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -19254,6 +19978,12 @@ } }, "/environments/{environmentId}/production-mode/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -19380,6 +20110,12 @@ } }, "/environments/{environmentId}/production-mode/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -19506,6 +20242,12 @@ } }, "/environments/{environmentId}/search": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -19588,6 +20330,12 @@ } }, "/environments/{environmentId}/search/indexes": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -19925,6 +20673,12 @@ } }, "/environments/{environmentId}/search/indexes/{indexId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -20273,6 +21027,12 @@ } }, "/environments/{environmentId}/servers": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -20458,6 +21218,12 @@ } }, "/environments/{environmentId}/servers/{serverId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -20751,6 +21517,12 @@ } }, "/environments/{environmentId}/servers/{serverId}/actions/reboot": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -20902,6 +21674,12 @@ } }, "/environments/{environmentId}/servers/{serverId}/actions/relaunch": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -21053,6 +21831,12 @@ } }, "/environments/{environmentId}/servers/{serverId}/actions/suspend": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -21204,6 +21988,12 @@ } }, "/environments/{environmentId}/servers/{serverId}/actions/upgrade": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -21363,6 +22153,12 @@ } }, "/environments/{environmentId}/settings": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -21422,6 +22218,12 @@ } }, "/environments/{environmentId}/settings/apm": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Application Performance Monitoring Services" @@ -21680,6 +22482,12 @@ } }, "/environments/{environmentId}/ssl": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -21771,6 +22579,12 @@ } }, "/environments/{environmentId}/ssl/certificates": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -22087,6 +22901,12 @@ } }, "/environments/{environmentId}/ssl/certificates/{certificateId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -22292,6 +23112,12 @@ } }, "/environments/{environmentId}/ssl/certificates/{certificateId}/actions/activate": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -22481,6 +23307,12 @@ } }, "/environments/{environmentId}/ssl/certificates/{certificateId}/actions/deactivate": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Environments" @@ -22620,6 +23452,12 @@ } }, "/environments/{environmentId}/ssl/csrs": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -22978,6 +23816,12 @@ } }, "/environments/{environmentId}/ssl/csrs/{certificateId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -23218,6 +24062,12 @@ } }, "/environments/{environmentId}/variables": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -23571,6 +24421,12 @@ } }, "/environments/{environmentId}/variables/{environmentVariableName}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Environments" @@ -24003,6 +24859,12 @@ } }, "/ides/{ideUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Cloud IDE" @@ -24055,8 +24917,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 +25017,12 @@ } }, "/identity-providers": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Identity Providers" @@ -24273,6 +25141,12 @@ } }, "/identity-providers/{identityProviderUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Identity Providers" @@ -24656,6 +25530,12 @@ } }, "/identity-providers/{identityProviderUuid}/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Identity Providers" @@ -24749,6 +25629,12 @@ } }, "/identity-providers/{identityProviderUuid}/actions/disable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Identity Providers" @@ -24842,6 +25728,12 @@ } }, "/invites/{token}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Invite" @@ -24883,8 +25775,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 +25797,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 +25925,12 @@ } }, "/invites/{token}/actions/accept": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Invite" @@ -25109,6 +26007,12 @@ } }, "/invites/{token}/actions/decline": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Invite" @@ -25185,6 +26089,12 @@ } }, "/invites/{token}/actions/resend": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Invite" @@ -25243,6 +26153,12 @@ } }, "/messages/{messageUuid}/actions/dismiss": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Messages" @@ -25320,6 +26236,12 @@ } }, "/messages/{messageUuid}/actions/follow": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Messages" @@ -25367,6 +26289,12 @@ } }, "/notifications/{notificationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Notifications" @@ -25398,8 +26326,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 +26375,12 @@ } }, "/options": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25487,6 +26421,12 @@ } }, "/options/cde-sizes": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25565,6 +26505,12 @@ } }, "/options/log-forwarding": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25605,6 +26551,12 @@ } }, "/options/log-forwarding/sources": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25650,6 +26602,12 @@ } }, "/options/log-forwarding/consumers": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25692,6 +26650,12 @@ } }, "/options/colors": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Options" @@ -25776,6 +26740,12 @@ } }, "/organizations": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -25904,6 +26874,12 @@ } }, "/organizations/{organizationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -26241,6 +27217,12 @@ } }, "/organizations/{organizationUuid}/actions/change-owner": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Organizations" @@ -26382,6 +27364,12 @@ } }, "/organizations/{organizationUuid}/actions/leave": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Organizations" @@ -26476,6 +27464,12 @@ } }, "/organizations/{organizationUuid}/admins": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -26605,6 +27599,12 @@ } }, "/organizations/{organizationUuid}/admins/{userUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -26774,6 +27774,12 @@ } }, "/organizations/{organizationUuid}/admin-invites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -26842,7 +27848,7 @@ }, "uuid": "f921fa88-47e3-49df-9dbb-75950aaca428", "email": "invitee@example.com", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "token": "dd9ea69fdcb6bee08b31a858b85535ec", "flags": { "declined": false @@ -26868,7 +27874,7 @@ }, "uuid": "857a8ec9-ac33-428d-8b1c-718d7f6f9aa4", "email": "invitee2@example.com", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "token": "dd9ea69fdcb6bee08b31a858b85535ed", "flags": { "declined": false @@ -27024,6 +28030,12 @@ } }, "/organizations/{organizationUuid}/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -27229,6 +28241,12 @@ } }, "/organizations/{organizationUuid}/available-tags": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -27822,6 +28840,12 @@ } }, "/organizations/{organizationUuid}/identity-provider": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -27893,6 +28917,12 @@ } }, "/organizations/{organizationUuid}/members": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28068,6 +29098,12 @@ } }, "/organizations/{organizationUuid}/members/{userUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28277,6 +29313,12 @@ } }, "/organizations/{organizationUuid}/members/{userUuid}/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28430,6 +29472,12 @@ } }, "/organizations/{organizationUuid}/notifications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28501,8 +29549,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 +29598,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 +29634,12 @@ } }, "/organizations/{organizationUuid}/roles": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -28671,7 +29725,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 +29773,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 +29812,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 +30042,12 @@ } }, "/organizations/{organizationUuid}/subscriptions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -29196,6 +30256,12 @@ } }, "/organizations/{organizationUuid}/team-invites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -29264,8 +30330,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" @@ -29286,7 +30352,7 @@ }, "uuid": "fd745f4b-178f-4c09-87cc-4061a60eb1c9", "email": "invitee@example.com", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "token": "dd9ea69fdcb6bee08b31a858b85535ec", "flags": { "declined": true @@ -29303,8 +30369,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" @@ -29329,7 +30395,7 @@ }, "uuid": "036612d0-8879-44a6-b2e2-93e0e30fc7fb", "email": "invitee2@example.com", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "token": "dd9ea69fdcb6bee08b31a858b85535ed", "flags": { "declined": false @@ -29346,8 +30412,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 +30434,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 +30473,12 @@ } }, "/organizations/{organizationUuid}/teams": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Organizations" @@ -29654,6 +30726,12 @@ } }, "/permissions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -30121,6 +31199,12 @@ } }, "/roles/{roleUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -30194,7 +31278,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 +31497,12 @@ } }, "/subscriptions": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -30477,8 +31567,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", @@ -30519,8 +31609,8 @@ "id": 222, "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", + "start_at": "2012-05-15T12:00:00Z", + "expire_at": "2015-05-15T12:00:00Z", "product": { "id": 8999, "name": "Enterprise", @@ -30561,8 +31651,8 @@ "id": 333, "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", + "start_at": "2012-05-15T12:00:00Z", + "expire_at": "2015-05-15T12:00:00Z", "product": { "id": 8999, "name": "Enterprise", @@ -30627,6 +31717,12 @@ } }, "/subscriptions/{subscriptionUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -30657,8 +31753,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 +31904,12 @@ } }, "/subscriptions/{subscriptionUuid}/apm": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Application Performance Monitoring Services" @@ -30902,6 +32004,12 @@ } }, "/subscriptions/{subscriptionUuid}/apm/{apmType}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Application Performance Monitoring Services" @@ -30976,6 +32084,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 +32208,12 @@ } }, "/subscriptions/{subscriptionUuid}/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -31234,6 +32354,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -31422,6 +32548,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio/actions/enable": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Subscriptions" @@ -31502,6 +32634,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -31639,6 +32777,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio/users": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -31863,6 +33007,12 @@ } }, "/subscriptions/{subscriptionUuid}/code-studio/users/{userUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -32041,6 +33191,12 @@ } }, "/subscriptions/{subscriptionUuid}/domains": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -32475,6 +33631,12 @@ } }, "/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -32728,6 +33890,12 @@ } }, "/subscriptions/{subscriptionUuid}/domains/{domainRegistrationUuid}/actions/verify": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Subscriptions" @@ -32839,6 +34007,12 @@ } }, "/subscriptions/{subscriptionUuid}/entitlements": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -32868,7 +34042,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 +34057,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 +34068,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 +34082,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 +34093,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 +34104,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 +34149,12 @@ } }, "/subscriptions/{subscriptionUuid}/ides": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33031,8 +34211,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 +34242,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 +34278,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33195,6 +34381,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/data": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33247,15 +34439,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 +34473,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 +34549,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/data-by-application": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33422,15 +34620,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 +34661,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 +34744,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/{usageMetric}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33582,15 +34786,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 +34859,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/views-by-application": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33720,15 +34930,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 +35013,12 @@ } }, "/subscriptions/{subscriptionUuid}/metrics/usage/visits-by-application": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -33868,15 +35084,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 +35167,12 @@ } }, "/subscriptions/{subscriptionUuid}/shield-acl": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -34236,6 +35458,12 @@ } }, "/subscriptions/{subscriptionUuid}/shield-acl/{shieldAclUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Subscriptions" @@ -34609,6 +35837,12 @@ } }, "/subscriptions/{subscriptionUuid}/shield-acl/actions/reset": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Subscriptions" @@ -34733,6 +35967,12 @@ } }, "/teams": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -34838,6 +36078,12 @@ } }, "/teams/{teamUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -35078,6 +36324,12 @@ } }, "/teams/{teamUuid}/actions/leave": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "post": { "tags": [ "Teams and Permissions" @@ -35154,6 +36406,12 @@ } }, "/teams/{teamUuid}/applications": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -35441,6 +36699,12 @@ } }, "/teams/{teamUuid}/applications/{applicationUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "delete": { "tags": [ "Teams and Permissions" @@ -35526,6 +36790,12 @@ } }, "/teams/{teamUuid}/invites": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -35621,7 +36891,7 @@ }, "uuid": "f4347e76-bcd7-41f6-91aa-ac6691755f0c", "email": "invitee@example.com", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "token": "dd9ea69fdcb6bee08b31a858b85535ec", "flags": { "declined": true @@ -35667,7 +36937,7 @@ }, "uuid": "6bf96944-bb9b-4629-b593-d658e44d8054", "email": "invitee2@example.com", - "created_at": "2012-05-15T12:00:00.000Z", + "created_at": "2012-05-15T12:00:00Z", "token": "dd9ea69fdcb6bee08b31a858b85535ed", "flags": { "declined": false @@ -35901,6 +37171,12 @@ } }, "/teams/{teamUuid}/members": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "get": { "tags": [ "Teams and Permissions" @@ -36023,6 +37299,12 @@ } }, "/teams/{teamUuid}/members/{userUuid}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api", + "description": "Cloud API" + } + ], "put": { "tags": [ "Teams and Permissions" @@ -36254,6 +37536,12 @@ } }, "/codebases/{codebaseId}/bulk-code-switch": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "api_codebases_codebaseIdbulk-code-switch_get_collection", "tags": [ @@ -36342,7 +37630,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 +38025,12 @@ } }, "/codebases/{codebaseId}/bulk-code-switch/{bulkCodeSwitchId}": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "get_bulk_code_switch_resource", "tags": [ @@ -36792,7 +38086,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 +38184,12 @@ } }, "/applications/{applicationId}/codebase": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "api_applications_applicationIdcodebase_get", "tags": [ @@ -36994,12 +38294,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 +38404,12 @@ } }, "/codebases": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "api_codebases_get_collection", "tags": [ @@ -37241,12 +38547,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 +38728,12 @@ } }, "/codebases/{codebaseId}": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "get_codebase_by_id", "tags": [ @@ -37526,12 +38838,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 +39218,12 @@ } }, "/subscriptions/{subscriptionId}/codebases": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "subscription_codebases", "tags": [ @@ -38043,12 +39361,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", @@ -38237,14 +39555,14 @@ } ] }, - "post": { - "operationId": "api_subscriptions_subscriptionIdcodebases_post", + "options": { + "operationId": "api_subscriptions_subscriptionIdcodebases_options", "tags": [ "Codebases" ], "responses": { - "201": { - "description": "Create a new codebase for a subscription.", + "200": { + "description": "Gets supported regions for a new codebase.", "content": { "application/hal+json": { "schema": { @@ -38259,7 +39577,7 @@ "href": { "type": "string", "format": "uri", - "example": "https://cloud.acquia.com/api/subscriptions/123/codebases" + "example": "https://cloud.acquia.com/api/subscriptions/123" } } }, @@ -38269,199 +39587,21 @@ "href": { "type": "string", "format": "uri", - "example": "https://cloud.acquia.com/api/codebases/a0c9dff7-56b6-4c0d-bad0-0e6593f66cd3" + "example": "https://cloud.acquia.com/api/subscriptions/123/codebases" } } } } }, - "message": { - "type": "string", - "example": "Codebase with label:test-codebase creation started." - } - } - } - } - } - }, - "400": { - "description": "Incomplete or incorrect request body.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "validation_failed" - }, - "message": { - "type": "object", - "properties": { - "label": { - "type": "string", - "example": "This value should not be null." - } - } - } - } - } - } - } - }, - "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": "Subscription not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "Subscription with id:invalid-sub-9999 could not be found." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } - } - }, - "summary": "Create a new codebase for a subscription.", - "description": "Create a new codebase for a subscription.", - "x-cli-name": "codebases:create", - "parameters": [ - { - "name": "subscriptionId", - "in": "path", - "description": "The entity's unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "requestBody": { - "description": "The new Codebase resource", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "codebase_id": { - "type": "string", - "format": "uuid", - "example": "a0c9dff7-56b6-4c0d-bad0-0e6593f66cd4" - }, - "label": { - "type": "string", - "example": "test-codebase" - }, - "region": { - "type": "string", - "example": "us-east-1" - } - }, - "required": [ - "codebase_id", - "label", - "region" - ] - } - } - }, - "required": false - }, - "deprecated": false, - "security": [ - { - "Codebase_Service_JWT": [] - } - ] - }, - "options": { - "operationId": "api_subscriptions_subscriptionIdcodebases_options", - "tags": [ - "Codebases" - ], - "responses": { - "200": { - "description": "Gets supported regions for a new codebase.", - "content": { - "application/hal+json": { - "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "parent": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/subscriptions/123" - } - } - }, - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/subscriptions/123/codebases" - } - } - } - } - }, - "regions": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "us-east-1", - "eu-west-1", - "us-west-2" - ] + "regions": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "us-east-1", + "eu-west-1", + "us-west-2" + ] } } } @@ -38545,231 +39685,13 @@ ] } }, - "/codebases/{codebaseId}/applications": { - "get": { - "operationId": "codebase_applications", - "x-prerelease": true, - "tags": [ - "Codebases" - ], - "responses": { - "200": { - "description": "Retrieves a list of applications by codebase ID.", - "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": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/applications/App1" - } - } - } - } - }, - "id": { - "type": "string", - "example": "App1" - }, - "machine_name": { - "type": "string", - "example": "APP_NAME" - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "parent": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778" - } - } - }, - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778/applications" - } - } - }, - "limit": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778/applications{?limit}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "offset": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template", - "example": "https://cloud.acquia.com/api/codebases/11111111-9cda-4ca3-af13-7a1c2fc66778/applications{?offset}" - }, - "templated": { - "type": "boolean", - "example": true - } - } - }, - "filter": { - "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": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "get_references_by_codebase", "tags": [ @@ -39016,6 +39938,12 @@ } }, "/codebases/{codebaseId}/references/{referenceName}": { + "servers": [ + { + "url": "/", + "description": "" + } + ], "get": { "operationId": "get_single_reference", "tags": [ @@ -39166,203 +40094,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 - } - } - } - } - } - } - }, - "summary": "Retrieve database info based on the site instance.", - "description": "Retrieve database info based on the site instance.", - "parameters": [ - { - "name": "siteId", - "in": "path", - "description": "Site 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": "environmentId", - "in": "path", - "description": "Environment 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" } - ], - "deprecated": false, + }, "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": [], + } + }, + "/private-networks/{privateNetworkId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "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" + }, + "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" + } + } + } + }, "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,494 +40253,425 @@ } }, "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 - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, - "403": { - "description": "Access Denied", + "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", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "forbidden" - }, - "message": { - "type": "string", - "example": "Access Denied." - }, - "code": { - "type": "integer", - "example": 403 + "$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" } } } } } }, + "401": { + "$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" + }, + "409": { + "$ref": "#/components/responses/Private_Network_Service_API_ConflictError" }, - "422": { - "description": "Unprocessable entity" + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } }, - "summary": "Copy a database from one environment to another.", - "description": "Copy a database from one environment to another.", + "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": "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_SubscriptionId" }, { - "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_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" } ], - "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" - } - } - } - } + "responses": { + "200": { + "$ref": "#/components/responses/Private_Network_Service_API_PrivateNetworkList" }, - "required": false + "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": [ { - "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": [], + "/private-networks/{privateNetworkId}/connections/vpns": { + "servers": [ + { + "url": "https://cloud.acquia.com/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" + } + } + } + } + }, "responses": { - "200": { - "description": "List Database backups of site instance.", + "202": { + "description": "VPN request accepted", "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" - } - } - } - } - } + "$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/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" - } - } - } - } + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns" } } } } } }, - "401": { - "description": "Authorization required.", + "400": { + "description": "Bad request", "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": { + "gateway_ip": "Invalid IP address format" } } } } }, - "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 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": [] + } + ] + }, + "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" }, { - "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, + "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}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "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" + }, + "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._environmentIddatabasebackups_post", - "x-cli-name": "site-instances:database:backups:create", - "x-prerelease": true, - "tags": [], + "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" + } + } + } + } + }, "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." - }, - "_links": { - "type": "object", - "properties": { + "$ref": "#/components/schemas/Private_Network_Service_API_Message" + }, + "examples": { + "creation": { + "summary": "VPN creation response", + "description": "Response when creating a new VPN", + "value": { + "_links": { "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" - } - } + "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." } } } @@ -39865,23 +40679,61 @@ } }, "400": { - "description": "Validation Error in request body.", + "$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 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": "VPN removed successfully", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "validation_failed" - }, - "message": { - "type": "string", - "example": "Invalid request body." + "$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" }, - "code": { - "type": "integer", - "example": 400 + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000" } } } @@ -39889,6670 +40741,456 @@ } }, "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 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" } }, - "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 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 - } - ], - "deprecated": false, - "security": [ + "$ref": "#/components/parameters/Private_Network_Service_API_Limit" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_Offset" + }, + { + "$ref": "#/components/parameters/Private_Network_Service_API_Sort" + }, { - "MEO_Environment_Service_JWT": [] + "$ref": "#/components/parameters/Private_Network_Service_API_Filter" } - ] - } - }, - "/site-instances/{siteId}.{environmentId}/database/backups/{id}": { - "get": { - "operationId": "get_database_backup", - "x-cli-name": "site-instances:database:backups:get", - "x-prerelease": true, - "tags": [], + ], + "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_VpcPeerList" }, "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 - } - } - } - } - } - } - }, - "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 + "$ref": "#/components/responses/Private_Network_Service_API_NotFoundError" }, - { - "name": "environmentId", - "in": "path", - "description": "Environment 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" } - ], - "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": [], - "responses": { - "202": { - "description": "Delete a site instance database backup", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Database backup deletion started." - } - } - } - } - } - }, - "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 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 - } - } - } - } - } - } - }, - "summary": "Delete a site instance database backup", - "description": "Delete a site instance database backup", + } + }, + "/private-networks/{privateNetworkId}/connections/vpc-peers/{vpcPeerId}": { + "servers": [ + { + "url": "https://cloud.acquia.com/api" + } + ], + "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", "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 + "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" }, { - "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_VpcPeerId" } ], - "deprecated": false, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/site-instances/{siteId}.{environmentId}/database/backups/{id}/actions/download": { - "get": { - "operationId": "api_site-instances_siteId._environmentIddatabasebackups_idactionsdownload_get", - "x-cli-name": "site-instances:database:backups:download", - "x-prerelease": true, - "tags": [], + "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" - } - } - } - }, - "201": { - "description": "Download a site instance Db backup", - "content": { - "application/hal+json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Database backup download started." - } - } - } - } - } + "$ref": "#/components/responses/Private_Network_Service_API_VpcPeer" }, "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" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" } }, - "summary": "Download a site instance Database backup", - "description": "Download a site instance Database backup.", - "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": [] + } + ] + }, + "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": [ { - "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" }, { - "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_VpcPeerId" } ], - "deprecated": false, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/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": [], + "tags": [ + "Private Networks" + ], "responses": { "202": { - "description": "Restore database backup", - "content": { - "application/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" - } - } - } - } - }, - "message": { - "type": "string", - "example": "Database restore started." - } - } - } - } - } - }, - "400": { - "description": "Invalid input" - }, - "401": { - "description": "Authorization required.", + "description": "VPC Peer removed successfully", "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 - } - } - } - } - } - }, - "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 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 - } - } - } - } - } - }, - "422": { - "description": "Unprocessable entity" - } - }, - "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", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "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, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/site-instances/{siteId}.{environmentId}/domains": { - "get": { - "operationId": "site_instance_domains", - "x-cli-name": "site-instances:domains", - "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 - } - } - } - } - } - } - } - }, - "_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.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 - } - } - }, - "filter": { - "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 - } - } - }, - "sort": { - "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{&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.d3f7270e-c45f-4801-9308-5e8afe84a323/domains?limit=25&offset=1" - } - } - } - } - } - } - } - } - } - }, - "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": "Site instance Domain not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "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." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } - } - }, - "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", - "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 - }, - { - "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, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/site-instances/{siteId}.{environmentId}/domains/{domainName}": { - "get": { - "operationId": "site_instance_domain", - "x-cli-name": "site-instances:domain", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "Domain 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/domains/example.com" - } - } - } - } - }, - "domain": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "example.com" - }, - "is_managed": { - "type": "boolean", - "example": 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 - } - } - } - } - } - }, - "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": "Domain not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The domain provided does not exist." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } - } - }, - "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", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "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, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - }, - "put": { - "operationId": "add_domain_to_site", - "x-cli-name": "site-instances:domain:add", - "x-prerelease": true, - "tags": [], - "responses": { - "201": { - "description": "Domain updated", - "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/domains/example.com" - } - } - } - } - }, - "name": { - "type": "string", - "example": "example.com" - } - } - } - } - } - }, - "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 - } - } - } - } - } - }, - "404": { - "description": "Domain not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The domain provided does not exist." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } - }, - "422": { - "description": "Unprocessable entity" - } - }, - "summary": "Associate a site and environment with a domain.", - "description": "Associate a site and environment with a domain.", - "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 - }, - { - "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": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - }, - "delete": { - "operationId": "api_site-instances_siteId._environmentIddomains_domainName_delete", - "x-cli-name": "site-instances:domain:delete", - "x-prerelease": true, - "tags": [], - "responses": { - "202": { - "description": "Dissociate a site and environment from a domain", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "www.example.com domain deletion for site_id:3e8ecbec-ea7c-4260-8414-ef2938c859bc started." - } - } - } - } - } - }, - "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": "Domain 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 - } - } - } - } - } - } - }, - "summary": "Dissociate a site and environment from a domain.", - "description": "Dissociate a site and environment from a domain.", - "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 - }, - { - "name": "domainName", - "in": "path", - "description": "Domain Name", - "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}/domains/{domainName}/status": { - "get": { - "operationId": "site_instance_domain_status", - "x-cli-name": "site-instances:domain:status", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "Domain Status", - "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.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" - ] - } - } - } - } - } - }, - "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": "Domain 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 - } - } - } - } - } - } - }, - "summary": "Retrieves site instance domain status.", - "description": "Retrieves site instance domain status.", - "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 - }, - { - "name": "domainName", - "in": "path", - "description": "Domain Name", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/codebases/{codebaseId}/environments": { - "get": { - "operationId": "environments_by_codebase", - "x-cli-name": "codebases:environments-list", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "List of environments.", - "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", - "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", - "properties": { - "self": { - "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" - } - } - }, - "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" - } - } - } - } - } - } - } - } - } - }, - "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": "Environment 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 - } - } - } - } - } - } - }, - "summary": "Retrieves all environments by codebase.", - "description": "Retrieves all environments by codebase.", - "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, - "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": "codebaseId", - "in": "path", - "description": "Codebase entity unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "explode": false, - "allowReserved": false - } - ], - "deprecated": false, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/codebases/{codebaseId}/environments/{environmentId}": { - "get": { - "operationId": "environment_by_codebase_id", - "x-cli-name": "codebases:environments-find", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "Environment 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/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" - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "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": "Environment 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 - } - } - } - } - } - } - }, - "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", - "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": [] - } - ] - } - }, - "/v3/environments/{environmentId}": { - "get": { - "operationId": "environment_by_id", - "x-cli-name": "environments-v3:find", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "Environment 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/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" - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "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": "Environment 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 - } - } - } - } - } - } - }, - "summary": "Retrieves an environment details by its uuid.", - "description": "Retrieves an environment details by its uuid.", - "parameters": [ - { - "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": [] - } - ] - }, - "put": { - "operationId": "update_environment", - "x-cli-name": "environments-v3:update", - "x-prerelease": true, - "tags": [], - "responses": { - "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": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "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" - }, - "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": "Environment 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": "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": "environmentId", - "in": "path", - "description": "Environment 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": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/sites/{siteId}/environments": { - "get": { - "operationId": "environments_by_site", - "x-cli-name": "sites:environments-list", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "List of environments.", - "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": { - "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": { - "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": "Environment 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 - } - } - } - } - } - } - }, - "summary": "Retrieves all environments by site.", - "description": "Retrieves all environments by site.", - "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": "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, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/environments/{environmentId}/site-instances": { - "post": { - "operationId": "api_environments_environmentIdsite-instances_post", - "x-cli-name": "environments:site-instances:create", - "x-prerelease": true, - "tags": [], - "responses": { - "201": { - "description": "Site instance creation started.", - "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": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "string", - "example": "https://cloud.acquia.com/api/environments/d3f7270e-c45f-4801-9308-5e8afe84a323/site-instances" - } - } - } - } - } - } - } - } - } - }, - "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": "The site instance already exists." - }, - "code": { - "type": "integer", - "example": 403 - } - } - } - } - } - }, - "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 - } - } - } - } - } - }, - "422": { - "description": "Unprocessable entity" - } - }, - "summary": "Associate a site with an environment.", - "description": "Associate a site with an environment.", - "parameters": [ - { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "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", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "Site Instance 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" - } - } - } - } - }, - "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" - }, - "example": [ - "example.com", - "example-2.com" - ] - } - } - } - } - } - }, - "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": "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 - } - } - } - } - } - } - }, - "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": [ - { - "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": [] - } - ] - }, - "delete": { - "operationId": "api_site-instances_siteId._environmentId_delete", - "x-prerelease": true, - "tags": [], - "responses": { - "202": { - "description": "Site Instance deleted", - "content": { - "application/hal+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" - } - } - } - } - } - } - } - } - } - }, - "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": "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 - } - } - } - } - } - } - }, - "summary": "Dissociate a site and environment with no grace period.", - "description": "Dissociate a site and environment with no grace period.", - "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}/actions/cancel": { - "post": { - "operationId": "api_site-instances_siteId._environmentIdactionscancel_post", - "x-cli-name": "site-instances:dissociate", - "x-prerelease": true, - "tags": [], - "responses": { - "202": { - "description": "Site Instance deleted", - "content": { - "application/hal+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" - } - } - } - } - } - } - } - } - } - }, - "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 - } - } - } - } - } - }, - "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 - } - } - } - } - } - }, - "422": { - "description": "Unprocessable entity" - } - }, - "summary": "Dissociate a site and environment.", - "description": "Dissociate a site and environment.", - "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 - } - ], - "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": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/site-instances/{siteId}.{environmentId}/files": { - "post": { - "operationId": "api_site-instances_siteId._environmentIdfiles_post", - "x-cli-name": "site-instances:files:copy", - "x-prerelease": true, - "tags": [], - "responses": { - "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" - } - } - } - } - } - } - } - } - } - }, - "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": "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": "Copy files from one environment to another.", - "description": "Copy files 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 - }, - { - "name": "siteId", - "in": "path", - "description": "Site unique identifier", - "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": { - "source_environment_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - } - } - } - }, - "required": false - }, - "deprecated": false, - "security": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/v3/environments/{environmentId}/actions/clear-caches": { - "post": { - "operationId": "postV3EnvironmentsClearCaches", - "x-cli-name": "environments-v3:clear-caches", - "x-prerelease": true, - "tags": [], - "responses": { - "202": { - "description": "Domains cache flush started.", - "content": { - "application/hal+json": { - "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "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 - } - } - } - } - } - }, - "404": { - "description": "Domain not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The domain provided does not exist." - }, - "code": { - "type": "integer", - "example": 404 - } - } - } - } - } - } - }, - "summary": "Clear caches for an environment with a list of domains.", - "description": "Clear caches for an environment with a list of domains.", - "parameters": [ - { - "name": "environmentId", - "in": "path", - "description": "Environment unique identifier", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "style": "simple", - "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": [ - { - "MEO_Environment_Service_JWT": [] - } - ] - } - }, - "/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" - }, - "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", - "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" - }, - "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" - } - } - } - }, - "responses": { - "202": { - "description": "Private network updated", - "content": { - "application/hal+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" - } - } - } - } - } - }, - "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", - "content": { - "application/hal+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" - } - } - } - } - } - }, - "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" - ], - "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" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Sort" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_Filter" - } - ], - "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": [ - { - "Private_Network_Service_API_BearerAuth": [], - "Private_Network_Service_API_ClientCredentials": [], - "Private_Network_Service_API_OIDC": [] - } - ] - } - }, - "/private-networks/{privateNetworkId}/connections/vpns": { - "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" - } - } - } - } - }, - "responses": { - "202": { - "description": "VPN request accepted", - "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" - }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns" - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/hal+json": { - "schema": { - "$ref": "#/components/schemas/Private_Network_Service_API_ValidationError" - }, - "example": { - "error": "validation_failed", - "message": { - "gateway_ip": "Invalid IP address format" - } - } - } - } - }, - "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" - }, - "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": "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" - } - } - } - } - }, - "responses": { - "202": { - "description": "VPN request accepted", - "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": { - "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." - } - } - } - } - } - }, - "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 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": "VPN removed successfully", - "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" - }, - "parent": { - "href": "https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000" - } - } - } - } - } - }, - "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" - } - } - } - }, - "responses": { - "202": { - "description": "VPC Peer request accepted", - "content": { - "application/hal+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" - }, - "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": { - "$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" - } - }, - "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", - "parameters": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - }, - { - "$ref": "#/components/parameters/Private_Network_Service_API_VpcPeerId" - } - ], - "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" - } - }, - "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": { - "$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" - } - } - } - } - } - }, - "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": { - "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 - } - } - } - } - }, - "responses": { - "202": { - "description": "Connections updated", - "content": { - "application/hal+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" - }, - "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" - } - }, - "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": [ - { - "$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" - }, - "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}/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" - ], - "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": "Isolation settings updated", - "content": { - "application/hal+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" - }, - "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" - } - }, - "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", - "content": { - "application/hal+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" - }, - "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" - } - }, - "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": [ - { - "$ref": "#/components/parameters/Private_Network_Service_API_PrivateNetworkId" - } - ], - "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" - }, - "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": [] - } - ] - } - }, - "/codebases/{codebaseId}/sites": { - "get": { - "operationId": "api_codebases_codebaseIdsites_get_collection", - "x-cli-name": "codebases:sites-list", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "A list of sites associated with a 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": 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": { - "self": { - "type": "object", - "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" - } - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Codebase sites 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." - } - } - } - } - } - } - }, - "summary": "Retrieves a list of sites associated with a codebase.", - "description": "Retrieves a list of site associated with a codebase.", - "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 - }, - { - "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, - "security": [ - { - "Site_Service_JWT": [] - } - ] - } - }, - "/environments/{environmentId}/sites": { - "get": { - "operationId": "api_environments_environmentIdsites_get_collection", - "x-cli-name": "environments:sites-list", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "A list of sites associated with an environment.", - "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/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/sites/0ebce493-9d09-479d-a9a8-138a206fa687" - } - } - }, - "site_instance": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/site-instances/0ebce493-9d09-479d-a9a8-138a206fa687.24-a47ac10b-58cc-4372-a567-0e02b2c3d470" - } - } - } - } - }, - "id": { - "type": "string", - "example": "0ebce493-9d09-479d-a9a8-138a206fa687" - }, - "name": { - "type": "string", - "example": "site1" - }, - "label": { - "type": "string", - "example": "My Site 1" - }, - "description": { - "type": "string", - "example": "My Site 1 description" - }, - "codebase_id": { - "type": "string", - "example": "8765-4321" - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/sites?limit=25&offset=1" - } - } - }, - "limit": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/sites?offset=1{&limit}", - "format": "uri-template" - } - } - }, - "offset": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/sites?limit=25{&offset}", - "format": "uri-template" - } - } - }, - "filter": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/sites?limit=25&offset=1{&filter}", - "format": "uri-template" - } - } - }, - "sort": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/sites?limit=25&offset=1{&sort}", - "format": "uri-template" - } - } - }, - "prev": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/environments/24-a47ac10b-58cc-4372-a567-0e02b2c3d470/sites?limit=25&offset=1" - } - } - } - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Environment sites not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The environment you are trying to access does not exist, or you do not have permission to access it." - } - } - } - } - } - } - }, - "summary": "Retrieves a list of sites associated with an environment.", - "description": "Retrieves a list of site associated with an environment.", - "parameters": [ - { - "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", - "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, - "security": [ - { - "Site_Service_JWT": [] - } - ] - } - }, - "/subscriptions/{subscriptionId}/sites": { - "get": { - "operationId": "api_subscriptions_subscriptionIdsites_get_collection", - "tags": [], - "x-cli-name": "subscriptions:sites-list", - "x-prerelease": true, - "responses": { - "200": { - "description": "A list of sites associated with a subscription.", - "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/sites/0ebce493-9d09-479d-a9a8-138a206fa687" - } - } - } - } - }, - "id": { - "type": "string", - "example": "0ebce493-9d09-479d-a9a8-138a206fa687" - }, - "name": { - "type": "string", - "example": "site1" - }, - "label": { - "type": "string", - "example": "My Site 1" - }, - "description": { - "type": "string", - "example": "My Site 1 description" - }, - "codebase_id": { - "type": "string", - "example": "8765-4321" - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/sites?limit=25&offset=1" - } - } - }, - "first": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/sites?limit=25&offset=1" - } - } - }, - "last": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/subscriptions/123e4567-e89b-12d3-a456-426614174000/sites?limit=25&offset=1" - } - } - } - } - } - } - } - } - } - } - }, - "summary": "Retrieves a list of sites associated with a subscription.", - "description": "Retrieves a list of sites associated with a subscription.", - "parameters": [ - { - "name": "subscriptionId", - "in": "path", - "description": "The entity's universally unique identifier.", - "required": true, - "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string" - }, - "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, - "security": [ - { - "Site_Service_JWT": [] - } - ] - } - }, - "/sites": { - "get": { - "operationId": "get_sites", - "x-cli-name": "sites:list", - "x-prerelease": true, - "tags": [], - "responses": { - "200": { - "description": "A list of sites accessible by the user.", - "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/sites/0ebce493-9d09-479d-a9a8-138a206fa687" - } - } - } - } - }, - "id": { - "type": "string", - "example": "0ebce493-9d09-479d-a9a8-138a206fa687" - }, - "name": { - "type": "string", - "example": "site1" - }, - "label": { - "type": "string", - "example": "My Site 1" - }, - "description": { - "type": "string", - "example": "My Site 1 description" - }, - "codebase_id": { - "type": "string", - "example": "8765-4321" - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites?limit=25&offset=1" - } - } - }, - "limit": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites?offset=1{&limit}", - "format": "uri-template" - } - } - }, - "offset": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites?limit=25{&offset}", - "format": "uri-template" - } - } - }, - "filter": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites?limit=25&offset=1{&filter}", - "format": "uri-template" - } - } - }, - "sort": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites?limit=25&offset=1{&sort}", - "format": "uri-template" - } - } - }, - "prev": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites?limit=25&offset=1" - } - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Sites not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The sites you are trying to access does not exist, or you do not have permission to access it.." - } - } - } - } - } - } - }, - "summary": "Retrieves a list of sites accessible by the user.", - "description": "Retrieves a list of sites accessible by the user.", - "parameters": [ - { - "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, - "security": [ - { - "Site_Service_JWT": [] - } - ] - }, - "post": { - "operationId": "api_sites_post", - "x-cli-name": "sites:create", - "x-prerelease": true, - "tags": [], - "responses": { - "201": { - "description": "Site created successfully.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Site with label:My Site 1 creation started." - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites/0ebce493-9d09-479d-a9a8-138a206fa687" - } - } - }, - "parent": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites" - } - } - } - } - } - } - } - } - } - }, - "400": { - "description": "Invalid input" - }, - "404": { - "description": "Site not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The site you are trying to access does not exist, or you do not have permission to access it." - } - } - } - } - } - }, - "422": { - "description": "Unprocessable entity" - } - }, - "summary": "Creates a site for a codebase.", - "description": "Creates a site for a codebase.", - "parameters": [], - "requestBody": { - "description": "The new Site resource", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "site_id": { - "type": "string", - "example": "0ebce493-9d09-479d-a9a8-138a206fa687" - }, - "name": { - "type": "string", - "example": "site1" - }, - "label": { - "type": "string", - "example": "My Site 1" - }, - "codebase_id": { - "type": "string", - "example": "0ebce493-9d09-479d-a9a8-138a206fa999" + "$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" + } } } } } }, - "required": 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": [ { - "Site_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] } }, - "/sites/{siteId}": { - "get": { - "operationId": "get_site_by_id", - "x-cli-name": "sites:find", - "x-prerelease": true, - "tags": [], + "/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 + } + } + } + } + }, "responses": { - "200": { - "description": "Details about a particular site.", + "202": { + "description": "Connections updated", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites/0ebce493-9d09-479d-a9a8-138a206fa687" - } - } - } - } - }, - "id": { - "type": "string", - "example": "0ebce493-9d09-479d-a9a8-138a206fa687" - }, - "name": { - "type": "string", - "example": "site1" - }, - "label": { - "type": "string", - "example": "My Site 1" - }, - "description": { - "type": "string", - "example": "My Site 1 description" + "$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" }, - "codebase_id": { - "type": "string", - "example": "8765-4321" + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" } } } } } }, - "403": { - "description": "Forbidden" + "400": { + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, "404": { - "description": "Site not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The site you are trying to access does not exist, or you do not have permission to access it." - } - } - } - } - } + "$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 Connections for a Private Network.", + "operationId": "getPrivateNetworkConnections", + "x-cli-name": "private-networks:get-connections", + "parameters": [ + { + "$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" + }, + "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" } }, - "summary": "Retrieves a site details by its ID.", - "description": "Retrieves a site details by its ID.", + "security": [ + { + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] + } + ] + } + }, + "/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": [ { - "name": "siteId", - "in": "path", - "description": "Site 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, + "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": [ { - "Site_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] }, "put": { - "operationId": "api_sites_siteId_put", - "x-cli-name": "sites:update", - "x-prerelease": true, - "tags": [], + "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": "Site updated successfully.", + "description": "Isolation settings updated", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Site update started." + "$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" }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites/0ebce493-9d09-479d-a9a8-138a206fa687" - } - } - } - } + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" } } } @@ -46560,163 +41198,145 @@ } }, "400": { - "description": "Invalid input" + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" }, - "403": { - "description": "Forbidden" + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, "404": { - "description": "Site not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The site you are trying to access does not exist, or you do not have permission to access it." - } - } - } - } - } + "$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": "Update a site details by its id.", - "description": "Update a site details by its id.", + "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": [ { - "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" + ], "requestBody": { - "description": "The updated Site resource", + "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "label": { - "type": "string", - "example": "My Site 1" - }, - "description": { - "type": "string", - "example": "This is a description of my site." - } + "$ref": "#/components/schemas/Private_Network_Service_API_Ingress" + }, + "example": { + "drupal_ssh": { + "ingress_acls": [ + "test-acls" + ], + "private": true } } } - }, - "required": false - }, - "deprecated": false, - "security": [ - { - "Site_Service_JWT": [] } - ] - }, - "delete": { - "operationId": "api_sites_siteId_delete", - "x-cli-name": "sites:delete", - "x-prerelease": true, - "tags": [], + }, "responses": { "202": { - "description": "Site delete started.", + "description": "Ingress settings updated", "content": { - "application/json": { + "application/hal+json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Site delete started." + "$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" }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://cloud.acquia.com/api/sites/0ebce493-9d09-479d-a9a8-138a206fa687" - } - } - } - } + "parent": { + "href": "https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000" } } } } } }, - "403": { - "description": "Forbidden" + "400": { + "$ref": "#/components/responses/Private_Network_Service_API_BadRequestError" + }, + "401": { + "$ref": "#/components/responses/Private_Network_Service_API_UnauthorizedError" }, "404": { - "description": "Site not found.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "type": "string", - "example": "not_found" - }, - "message": { - "type": "string", - "example": "The site you are trying to access does not exist, or you do not have permission to access it." - } - } - } - } - } + "$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": "Deletes a site by its ID.", - "description": "Deletes a site by its ID.", + "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 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, + "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" + }, + "500": { + "$ref": "#/components/responses/Private_Network_Service_API_InternalServerError" + } + }, "security": [ { - "Site_Service_JWT": [] + "Private_Network_Service_API_BearerAuth": [], + "Private_Network_Service_API_ClientCredentials": [], + "Private_Network_Service_API_OIDC": [] } ] } @@ -46766,7 +41386,7 @@ "schema": { "type": "string" }, - "example": "2023-09-01T00:00:00.000Z" + "example": "2023-09-01" }, "Acquia_Cloud_API_Documentation_to": { "name": "to", @@ -46776,7 +41396,7 @@ "schema": { "type": "string" }, - "example": "2023-09-29T00:00:00.000Z" + "example": "2023-09-29" }, "Acquia_Cloud_API_Documentation_sort": { "name": "sort", @@ -47016,7 +41636,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 +41647,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 +41719,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 +41729,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 +41972,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 +46990,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 +47015,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 +55000,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 +55030,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 +55378,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 +55471,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 +55837,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 +55913,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 +56035,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 +56051,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 +56161,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 +56270,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..d0b0d9b38 100644 --- a/assets/acquia-spec.version +++ b/assets/acquia-spec.version @@ -1 +1 @@ -c1a6c6733a1ec7a8d3344cc2a2390f694ab73335 +adc8fd43c841c9d206f90b4bc124f8bff46aeed9