Environment Management API Reference

advanced

📜Advancedcms

Overview

The Environment Management API provides programmatic access to Optimizely Cloud operations. Use this API to automate deployments, manage environment configuration, and integrate with external CI/CD pipelines.

Base URL: https://paasportal.episerver.net/api/v1.0

Authentication

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer <api-key>

Generate API keys in the management portal under Settings > API Keys. Keys are scoped to a project and can be limited to specific operations.

Projects

List projects

GET /projects

Returns all projects accessible to the authenticated user.

Response:

{
  "projects": [
    {
      "id": "abc123",
      "name": "My CMS Site",
      "environments": ["Integration", "Preproduction", "Production"],
      "createdAt": "2025-06-15T10:30:00Z"
    }
  ]
}

Get project details

GET /projects/{projectId}

Returns detailed information about a project including environment status and deployment history summary.

Deployments

Create deployment

POST /projects/{projectId}/deployments
Content-Type: multipart/form-data

Uploads a deployment package and triggers a deployment.

Form fields:

Field	Type	Required	Description
`file`	file	Yes	Deployment package (.zip)
`targetEnvironment`	string	Yes	Target environment name
`description`	string	No	Deployment description

Response (202 Accepted):

{
  "id": "dep-789",
  "status": "queued",
  "targetEnvironment": "Integration",
  "createdAt": "2026-03-25T14:00:00Z",
  "statusUrl": "/projects/abc123/deployments/dep-789"
}

Get deployment status

GET /projects/{projectId}/deployments/{deploymentId}

Response:

{
  "id": "dep-789",
  "status": "succeeded",
  "targetEnvironment": "Integration",
  "startedAt": "2026-03-25T14:00:05Z",
  "completedAt": "2026-03-25T14:03:22Z",
  "commitId": "a1b2c3d",
  "commitMessage": "Add new landing page template"
}

Status values: queued, building, deploying, succeeded, failed, rolled-back

List deployments

GET /projects/{projectId}/deployments?environment={name}&limit={n}

Query parameters:

Parameter	Type	Default	Description
`environment`	string	all	Filter by environment
`limit`	integer	10	Number of results (max 100)
`offset`	integer	0	Pagination offset

Promote deployment

POST /projects/{projectId}/deployments/{deploymentId}/promote
Content-Type: application/json

Request body:

{
  "targetEnvironment": "Preproduction"
}

Response (202 Accepted): Returns a new deployment object for the target environment.

Rollback

POST /projects/{projectId}/environments/{environment}/rollback

Rolls back to the previous successful deployment.

Response (202 Accepted): Returns a new deployment object.

Environment variables

List variables

GET /projects/{projectId}/environments/{environment}/variables

Returns all environment variables. Sensitive values are masked.

Response:

{
  "variables": [
    {
      "name": "MY_SETTING",
      "value": "my-value",
      "isSecret": false
    },
    {
      "name": "API_KEY",
      "value": "********",
      "isSecret": true
    }
  ]
}

Set variable

PUT /projects/{projectId}/environments/{environment}/variables/{name}
Content-Type: application/json

Request body:

{
  "value": "new-value",
  "isSecret": false
}

Response (200 OK): Returns the updated variable.

Delete variable

DELETE /projects/{projectId}/environments/{environment}/variables/{name}

Response (204 No Content)

Database operations

Get database info

GET /projects/{projectId}/environments/{environment}/database

Returns database connection details and size information.

Response:

{
  "server": "server.database.windows.net",
  "database": "myproject_inte",
  "sizeMB": 1024,
  "maxSizeMB": 5120,
  "backupRetentionDays": 35
}

Export database

POST /projects/{projectId}/environments/{environment}/database/export

Initiates a database export. Returns a status URL to poll for completion.

Response (202 Accepted):

{
  "exportId": "exp-456",
  "status": "in-progress",
  "statusUrl": "/projects/abc123/environments/Production/database/exports/exp-456"
}

Import database

POST /projects/{projectId}/environments/{environment}/database/import
Content-Type: application/json

Request body:

{
  "sourceEnvironment": "Production"
}

Imports a database from another environment. The target database is replaced.

CDN operations

Purge cache

POST /projects/{projectId}/environments/{environment}/cdn/purge
Content-Type: application/json

Request body (purge URL):

{
  "type": "url",
  "value": "https://www.example.com/en/page/"
}

Request body (purge path prefix):

{
  "type": "path",
  "value": "/en/blog/*"
}

Request body (full purge):

{
  "type": "all"
}

Response (202 Accepted):

{
  "purgeId": "prg-321",
  "status": "in-progress",
  "estimatedCompletionSeconds": 30
}