Optimizely DXP Cloud API

{"openapi":"3.0.0","info":{"version":"v1","title":"Episerver Cloud API","description":"This document describes the functionality of the DXP Service Management Portal that can be invoked via REST API","contact":{"name":"Episerver AB","url":"https://www.episerver.com","email":"support@episerver.com"}},"paths":{"/api/v1.0/projects/{projectId}/environments/{environment}/storagecontainers":{"get":{"tags":["Blob Storage Containers"],"summary":"Get the list of blob storage containers for specified project Id and environment","operationId":"BlobStorageContainersApi_GetBlobStorageContainers","parameters":[{"name":"projectId","in":"path","description":"Project Id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"environment","in":"path","description":"Environment Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlobStorageContainersApiResponse"},"examples":{"response":{"value":{"success":true,"errors":[],"result":{"projectId":"c943975b-d468-4b85-8e62-5967b9eeeece","environment":"Preproduction","storageContainers":["Blob-Storage-Container-1","Blob-Storage-Container-2"]}}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}}},"/api/v1.0/projects/{projectId}/environments/{environment}/storagecontainers/{containerName}/saslink":{"post":{"tags":["Blob Storage Containers"],"summary":"Generate a new SAS link for the projectId, environment and containerName combination.\r\nThe generated link is valid for 24 hours by default if not requested by user (retention hours) otherwise.","operationId":"BlobStorageContainersApi_GenerateSasLink","parameters":[{"name":"projectId","in":"path","description":"Project identifier","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"environment","in":"path","description":"Name of the environment","required":true,"schema":{"type":"string"}},{"name":"containerName","in":"path","description":"Name of the blob storage container","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateBlobContainerSasLinkRequestParameters"}}},"description":"Request parameters that includes RetentionHours","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateBlobContainerSasLinkApiResponse"},"examples":{"response":{"value":{"success":true,"errors":[],"result":{"projectId":"c943975b-d468-4b85-8e62-5967b9eeeece","environment":"Preproduction","containerName":"deploymentpackages","sasLink":"https://codepackagesrepo.blob.core.windows.net/deploymentpackages","expiresOn":"2021-03-05T06:13:29.1772593Z"}}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}}},"/api/v1.0/projects/{projectId}/environments/{environment}/databases/{databaseName}/exports":{"post":{"tags":["DatabaseExports"],"summary":"Starts the database export process.","description":"When export process is completed, returns a read-only Azure Blob Storage SAS URI of the exported database bacpac file.\r\nBy default, the bacpac file is retained for 24 hours unless otherwise the retention hour is overridden.","operationId":"DatabaseExportApi_ExportDatabase","parameters":[{"name":"projectId","in":"path","description":"Project Id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"environment","in":"path","description":"Environment Name","required":true,"schema":{"type":"string"}},{"name":"databaseName","in":"path","description":"Database Name. Valid and accepted values are epicms/epicommerce","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartExportDatabaseRequestParameters"}}},"description":"Start export database request parameter","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportDatabaseResponse"},"examples":{"response":{"value":{"success":false,"errors":null,"result":{"id":"1b22aaf0-5e39-40d5-a0b9-fd15cbb38719","projectId":"ad5b41d1-8345-4038-a13e-f82bfe867b6f","databaseName":"epicms","databaseDisplayName":"epicms","bacpacName":null,"environment":"Production","status":"Started","downloadLink":null}}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}}},"/api/v1.0/projects/{projectId}/environments/{environment}/databases/{databaseName}/exports/{exportId}":{"get":{"tags":["DatabaseExports"],"summary":"Gets information about the database export process for the specified project and export.","operationId":"DatabaseExportApi_GetExportDatabase","parameters":[{"name":"projectId","in":"path","description":"Project Id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"environment","in":"path","description":"Environment Name","required":true,"schema":{"type":"string"}},{"name":"databaseName","in":"path","description":"Database Name","required":true,"schema":{"type":"string"}},{"name":"exportId","in":"path","description":"Export Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportDatabaseResponse"},"examples":{"response":{"value":{"success":false,"errors":null,"result":{"id":"1b22aaf0-5e39-40d5-a0b9-fd15cbb38719","projectId":"ad5b41d1-8345-4038-a13e-f82bfe867b6f","databaseName":"epicms","databaseDisplayName":"epicms","bacpacName":null,"environment":"Production","status":"Succeeded","downloadLink":"example.download.link"}}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}}},"/api/v1.0/projects/{projectId}/packages/location":{"get":{"tags":["Deployments"],"summary":"Retrieves deployment package upload location","description":"Returned path is a write-only Azure Blob Storage SAS URI. Deployment package(s) should be uploaded here before starting deployment.\r\nThe SAS URI will be usable for 24 hours, then a new location must be retrieved.","operationId":"UploadPackageApi_GetUploadPackageLocation","parameters":[{"name":"projectId","in":"path","description":"Project ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadPackageLocationResponse"},"examples":{"response":{"value":{"success":true,"errors":[],"result":{"location":"https://episite.blob.core.windows.net/packages"}}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred"],"result":null}}}}}}}}},"/api/v1.0/projects/{projectId}/deployments/{deploymentId}/reset":{"post":{"tags":["Deployments"],"summary":"Reset or Complete reset a specified deployment.","description":"Operation is available after start deployment has finished during the verification stage or reset-verification stage of the deployment.\r\nThis will abort deployment and reset the staging slot to allow for a new deployment.\r\nThis will also complete the on-going reset progress if maintenance mode was applied for the deployment.","operationId":"ResetCodeDeploymentApi_ResetCodeDeployment","parameters":[{"name":"projectId","in":"path","description":"Project ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"deploymentId","in":"path","description":"Deployment ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetDeploymentRequestParameters"}}},"description":"The reset deployment parameters","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetDeploymentResponse"},"examples":{"response":{"value":{"success":true,"errors":[],"result":{"id":"a9d75c10-56a1-4d1a-b58d-fe9e9b8dfd00","projectId":"a695406b-f24f-4d82-908a-aaa4009e514f","status":"AwaitingVerification","startTime":"2019-10-29T08:00:00Z","endTime":null,"percentComplete":100,"validationLinks":["https://episite.dxcloud.episerver.net/"],"deploymentWarnings":[],"deploymentErrors":[],"parameters":null}}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}}},"/api/v1.0/projects/{projectId}/deployments/{deploymentId}":{"get":{"tags":["Deployments"],"summary":"Get deployment details.","operationId":"GetDeploymentDetailsApi_GetDeploymentDetails","parameters":[{"name":"projectId","in":"path","description":"Project ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"deploymentId","in":"path","description":"Deployment ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentDetailsResponse"},"examples":{"response":{"value":{"success":true,"errors":[],"result":{"id":"a9d75c10-56a1-4d1a-b58d-fe9e9b8dfd00","projectId":"a695406b-f24f-4d82-908a-aaa4009e514f","status":"Succeeded","startTime":"2019-10-29T08:00:00Z","endTime":null,"percentComplete":100,"validationLinks":["https://episite.dxcloud.episerver.net/"],"deploymentWarnings":[],"deploymentErrors":[],"parameters":null}}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}}},"/api/v1.0/projects/{projectId}/deployments/{deploymentId}/complete":{"post":{"tags":["Deployments"],"summary":"Complete specified deployment.","description":"Operation is available only after start deployment has finished during the verification stage of the deployment.\r\nThis will complete deployment and swap it into the production slot.","operationId":"CompleteCodeDeploymentApi_CompleteCodeDeployment","parameters":[{"name":"projectId","in":"path","description":"Project ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"deploymentId","in":"path","description":"Deployment ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteDeploymentResponse"},"examples":{"response":{"value":{"success":true,"errors":[],"result":{"id":"a9d75c10-56a1-4d1a-b58d-fe9e9b8dfd00","projectId":"a695406b-f24f-4d82-908a-aaa4009e514f","status":"AwaitingVerification","startTime":"2019-10-29T08:00:00Z","endTime":null,"percentComplete":100,"validationLinks":["https://episite.dxcloud.episerver.net/"],"deploymentWarnings":[],"deploymentErrors":[],"parameters":null}}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}}},"/api/v1.0/projects/{projectId}/deployments":{"get":{"tags":["Deployments"],"summary":"Gets a list of deployments for specified project.","operationId":"DeploymentApi_GetDeploymentList","parameters":[{"name":"projectId","in":"path","description":"Project ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentListResponse"},"examples":{"response":{"value":{"success":true,"errors":null,"result":[{"id":"a9d75c10-56a1-4d1a-b58d-fe9e9b8dfd00","projectId":"a695406b-f24f-4d82-908a-aaa4009e514f","status":"Succeeded","startTime":"2019-10-29T08:00:00Z","endTime":null,"percentComplete":100,"validationLinks":["https://episite.dxcloud.episerver.net/"],"deploymentWarnings":[],"deploymentErrors":[],"parameters":null}]}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}},"post":{"tags":["Deployments"],"summary":"Starts deployment to target environment.","description":"Deployment can use either deployment package or environment as source.","operationId":"DeploymentApi_StartCodeDeployment","parameters":[{"name":"projectId","in":"path","description":"Project ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCodeDeploymentRequestParameters"}}},"description":"Request parameters","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartDeploymentResponse"},"examples":{"response":{"value":{"success":true,"errors":[],"result":{"id":"a9d75c10-56a1-4d1a-b58d-fe9e9b8dfd00","projectId":"a695406b-f24f-4d82-908a-aaa4009e514f","status":"InProgress","startTime":"2019-10-29T08:00:00Z","endTime":null,"percentComplete":10,"validationLinks":["https://episite.dxcloud.episerver.net/"],"deploymentWarnings":[],"deploymentErrors":[],"parameters":null}}}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Project Id is a required field."],"result":null}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["Access is denied for project c943975b-d468-4b85-8e62-5967b9eeeece or environment Preproduction."],"result":null}}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["There is no active project found for project id: c943975b-d468-4b85-8e62-5967b9eeeece."],"result":null}}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorApiErrorResponseExample"},"examples":{"response":{"value":{"success":false,"errors":["An error occurred while processing the request; Try again later."],"result":null}}}}}}}}}},"servers":[{"url":"https://paasportal.episerver.net"}],"components":{"schemas":{"GetBlobStorageContainersApiResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"result":{"$ref":"#/components/schemas/GetBlobStorageContainersResponse"},"success":{"type":"boolean"}}},"GetBlobStorageContainersResponse":{"type":"object","properties":{"environment":{"type":"string"},"storageContainers":{"type":"array","items":{"type":"string"}},"projectId":{"format":"uuid","type":"string"}}},"BadRequestApiErrorResponseExample":{"type":"object","properties":{}},"UnauthorizedApiErrorResponseExample":{"type":"object","properties":{}},"NotFoundApiErrorResponseExample":{"type":"object","properties":{}},"InternalServerErrorApiErrorResponseExample":{"type":"object","properties":{}},"GenerateBlobContainerSasLinkRequestParameters":{"type":"object","properties":{"retentionHours":{"format":"int32","type":"integer"}},"example":{"retentionHours":24}},"GenerateBlobContainerSasLinkApiResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"result":{"$ref":"#/components/schemas/GenerateBlobContainerSasLinkResponse"},"success":{"type":"boolean"}}},"GenerateBlobContainerSasLinkResponse":{"type":"object","properties":{"environment":{"type":"string"},"containerName":{"type":"string"},"sasLink":{"type":"string"},"expiresOn":{"format":"date-time","type":"string"},"projectId":{"format":"uuid","type":"string"}}},"StartExportDatabaseRequestParameters":{"type":"object","properties":{"retentionHours":{"format":"int32","type":"integer"}},"example":{"retentionHours":72}},"ExportDatabaseResponse":{"type":"object","properties":{"projectId":{"format":"uuid","type":"string"},"databaseName":{"type":"string"},"databaseDisplayName":{"type":"string","readOnly":true},"bacpacName":{"type":"string"},"environment":{"type":"string"},"status":{"type":"string"},"downloadLink":{"type":"string"},"id":{"format":"uuid","type":"string"}}},"UploadPackageLocationResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"result":{"$ref":"#/components/schemas/PackageLocationResultModel"},"success":{"type":"boolean"}}},"PackageLocationResultModel":{"type":"object","properties":{"location":{"type":"string"}}},"ApiErrorResponseExample":{"type":"object","properties":{}},"ResetDeploymentRequestParameters":{"type":"object","properties":{"validateBeforeSwap":{"type":"boolean"},"complete":{"type":"boolean"},"resetWithDbRollback":{"type":"boolean"}},"example":{"resetWithDbRollback":true,"validateBeforeSwap":true,"complete":false}},"ResetDeploymentResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"result":{"$ref":"#/components/schemas/DeploymentApiResponseModel"},"success":{"type":"boolean"}}},"DeploymentApiResponseModel":{"type":"object","properties":{"projectId":{"format":"uuid","type":"string"},"status":{"type":"string"},"startTime":{"format":"date-time","type":"string"},"endTime":{"format":"date-time","type":"string"},"percentComplete":{"format":"int32","type":"integer"},"validationLinks":{"type":"array","items":{"type":"string"}},"deploymentWarnings":{"type":"array","items":{"type":"string"}},"deploymentErrors":{"type":"array","items":{"type":"string"}},"parameters":{"$ref":"#/components/schemas/CodeDeploymentRequest"},"id":{"format":"uuid","type":"string"}}},"CodeDeploymentRequest":{"type":"object","properties":{"maintenancePage":{"type":"boolean"},"zeroDowntimeMode":{"type":"string"},"targetEnvironment":{"type":"string"}}},"DeploymentDetailsResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"result":{"$ref":"#/components/schemas/DeploymentApiResponseModel"},"success":{"type":"boolean"}}},"CompleteDeploymentResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"result":{"$ref":"#/components/schemas/DeploymentApiResponseModel"},"success":{"type":"boolean"}}},"DeploymentListResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"result":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentApiResponseModel"}},"success":{"type":"boolean"}}},"StartCodeDeploymentRequestParameters":{"type":"object","properties":{"sourceApps":{"type":"array","items":{"type":"string"}},"targetEnvironment":{"type":"string"},"maintenancePage":{"type":"boolean"},"includeBlob":{"type":"boolean"},"includeDb":{"type":"boolean"},"directDeploy":{"type":"boolean"},"packages":{"type":"array","items":{"type":"string"}},"zeroDowntimeMode":{"type":"string"},"sourceEnvironment":{"type":"string"}},"example":{"targetEnvironment":"Preproduction","maintenancePage":true,"includeBlob":false,"includeDb":false,"directDeploy":false,"packages":["site.cms.app.1.0.0.nupkg"],"zeroDowntimeMode":"ReadOnly"}},"StartDeploymentResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"result":{"$ref":"#/components/schemas/DeploymentApiResponseModel"},"success":{"type":"boolean"}}}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}