diff --git a/shared/pages/api.html b/shared/pages/api.html index 02f0208650..3e44d181d7 100644 --- a/shared/pages/api.html +++ b/shared/pages/api.html @@ -473,7 +473,7 @@ -
Upsun logo
API docs by Redocly
Upsun logo
API docs by Redocly
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

List organizations

{schemes}://api.upsun.com/users/{user_id}/organizations

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

List organizations

Non-admin users will only see organizations they are members of.

Authorizations:
OAuth2
query Parameters
object (StringFilter)

Allows filtering by id using one or more operators.

@@ -787,7 +787,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "_links": {
    }
}

Create organization

{schemes}://api.upsun.com/organizations

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "_links": {
    }
}

Create organization

Creates a new organization.

Authorizations:
OAuth2
Request Body schema: application/json
required
label
required
string

The human-readable label of the organization.

@@ -807,7 +807,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Request samples

Content type
application/json
{
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "name": "string",
  • "label": "string",
  • "country": "st"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "namespace": "string",
  • "name": "string",
  • "label": "string",
  • "country": "st",
  • "capabilities": [
    ],
  • "vendor": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get organization

{schemes}://api.upsun.com/organizations

Request samples

Content type
application/json
{
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "name": "string",
  • "label": "string",
  • "country": "st"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "namespace": "string",
  • "name": "string",
  • "label": "string",
  • "country": "st",
  • "capabilities": [
    ],
  • "vendor": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get organization

Retrieves the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "namespace": "string",
  • "name": "string",
  • "label": "string",
  • "country": "st",
  • "capabilities": [
    ],
  • "vendor": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update organization

{schemes}://api.upsun.com/organizations/{organization_id}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "namespace": "string",
  • "name": "string",
  • "label": "string",
  • "country": "st",
  • "capabilities": [
    ],
  • "vendor": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update organization

Updates the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -841,7 +841,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "country": "st"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "namespace": "string",
  • "name": "string",
  • "label": "string",
  • "country": "st",
  • "capabilities": [
    ],
  • "vendor": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete organization

{schemes}://api.upsun.com/organizations/{organization_id}

Request samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "country": "st"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "namespace": "string",
  • "name": "string",
  • "label": "string",
  • "country": "st",
  • "capabilities": [
    ],
  • "vendor": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete organization

Deletes the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -855,7 +855,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Organization Members

List organization members

{schemes}://api.upsun.com/organizations/{organization_id}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Organization Members

List organization members

Accessible to organization owners and members with the "manage members" permission.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "_links": {
    }
}

Create organization member

{schemes}://api.upsun.com/organizations/{organization_id}/members

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "_links": {
    }
}

Create organization member

Creates a new organization member.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -903,7 +903,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "permissions": [
    ],
  • "level": "admin",
  • "owner": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get organization member

{schemes}://api.upsun.com/organizations/{organization_id}/members

Request samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "permissions": [
    ],
  • "level": "admin",
  • "owner": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get organization member

Retrieves the specified organization member.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "permissions": [
    ],
  • "level": "admin",
  • "owner": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update organization member

{schemes}://api.upsun.com/organizations/{organization_id}/members/{user_id}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "permissions": [
    ],
  • "level": "admin",
  • "owner": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update organization member

Updates the specified organization member.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -937,7 +937,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "permissions": [
    ],
  • "level": "admin",
  • "owner": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete organization member

{schemes}://api.upsun.com/organizations/{organization_id}/members/{user_id}

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "permissions": [
    ],
  • "level": "admin",
  • "owner": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete organization member

Deletes the specified organization member.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -951,7 +951,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Organization Invitations

Invite user to an organization by email

{schemes}://api.upsun.com/organizations/{organization_id}/members/{user_id}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Organization Invitations

Invite user to an organization by email

Creates an invitation to an organization for a user with the specified email address.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -971,7 +971,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Conflict when there already is a pending invitation for the invitee

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "permissions": [
    ],
  • "force": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "pending",
  • "organization_id": "string",
  • "email": "user@example.com",
  • "owner": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "permissions": [
    ]
}

List invitations to an organization

{schemes}://api.upsun.com/organizations/{organization_id}/invitations

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "permissions": [
    ],
  • "force": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "pending",
  • "organization_id": "string",
  • "email": "user@example.com",
  • "owner": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "permissions": [
    ]
}

List invitations to an organization

Returns a list of invitations to an organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -993,7 +993,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
[
  • {
    }
]

Cancel a pending invitation to an organization

{schemes}://api.upsun.com/organizations/{organization_id}/invitations

Response samples

Content type
application/json
[
  • {
    }
]

Cancel a pending invitation to an organization

Cancels the specified invitation.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1007,7 +1007,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Organization Projects

List projects

{schemes}://api.upsun.com/organizations/{organization_id}/invitations/{invitation_id}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Organization Projects

List projects

Retrieves a list of projects for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1043,7 +1043,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Create project

{schemes}://api.upsun.com/organizations/{organization_id}/projects

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Create project

Creates a new project in the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1073,7 +1073,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "organization_id": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "default_branch": "string",
  • "cse_notes": "string",
  • "dedicated_tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "subscription_id": "string",
  • "vendor": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "timezone": "string",
  • "default_branch": "string",
  • "status": "requested",
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get project

{schemes}://api.upsun.com/organizations/{organization_id}/projects

Request samples

Content type
application/json
{
  • "organization_id": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "default_branch": "string",
  • "cse_notes": "string",
  • "dedicated_tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "subscription_id": "string",
  • "vendor": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "timezone": "string",
  • "default_branch": "string",
  • "status": "requested",
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get project

Retrieves the specified project.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1087,7 +1087,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "subscription_id": "string",
  • "vendor": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "timezone": "string",
  • "default_branch": "string",
  • "status": "requested",
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update project

{schemes}://api.upsun.com/organizations/{organization_id}/projects/{project_id}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "subscription_id": "string",
  • "vendor": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "timezone": "string",
  • "default_branch": "string",
  • "status": "requested",
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update project

Updates the specified project.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1113,7 +1113,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "title": "string",
  • "plan": "string",
  • "timezone": "string",
  • "cse_notes": "string",
  • "dedicated_tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "subscription_id": "string",
  • "vendor": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "timezone": "string",
  • "default_branch": "string",
  • "status": "requested",
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete project

{schemes}://api.upsun.com/organizations/{organization_id}/projects/{project_id}

Request samples

Content type
application/json
{
  • "title": "string",
  • "plan": "string",
  • "timezone": "string",
  • "cse_notes": "string",
  • "dedicated_tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "subscription_id": "string",
  • "vendor": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "timezone": "string",
  • "default_branch": "string",
  • "status": "requested",
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete project

Deletes the specified project.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1127,7 +1127,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Query project carbon emissions metrics

{schemes}://api.upsun.com/organizations/{organization_id}/projects/{project_id}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Query project carbon emissions metrics

Queries the carbon emission data for the specified project using the supplied parameters.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1149,7 +1149,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "project_id": "string",
  • "project_title": "string",
  • "meta": {
    },
  • "values": [
    ],
  • "total": 0
}

Add-ons

Get add-ons

{schemes}://api.upsun.com/organizations/{organization_id}/projects/{project_id}/metrics/carbon

Response samples

Content type
application/json
{
  • "project_id": "string",
  • "project_title": "string",
  • "meta": {
    },
  • "values": [
    ],
  • "total": 0
}

Add-ons

Get add-ons

Retrieves information about the add-ons for an organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "available": {
    },
  • "current": {
    },
  • "upgrades_available": {
    }
}

Project

Project Overview

{schemes}://api.upsun.com/organizations/{organization_id}/addons

Response samples

Content type
application/json
{
  • "available": {
    },
  • "current": {
    },
  • "upgrades_available": {
    }
}

Project

Project Overview

Using the Access Token " class="sc-eVqvcJ sc-fszimp kIppRw fOdxau">

Retrieve the details of a single project.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "attributes": {
    },
  • "title": "string",
  • "description": "string",
  • "owner": "string",
  • "namespace": "string",
  • "organization": "string",
  • "default_branch": "string",
  • "status": {
    },
  • "timezone": "string",
  • "region": "string",
  • "repository": {
    },
  • "default_domain": "string",
  • "subscription": {
    }
}

Update a project

{schemes}://api.upsun.com/projects/{projectId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "attributes": {
    },
  • "title": "string",
  • "description": "string",
  • "owner": "string",
  • "namespace": "string",
  • "organization": "string",
  • "default_branch": "string",
  • "status": {
    },
  • "timezone": "string",
  • "region": "string",
  • "repository": {
    },
  • "default_domain": "string",
  • "subscription": {
    }
}

Update a project

Update the details of an existing project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
Request Body schema: application/json
required
object (Arbitrary attributes attached to this resource)
title
string (Title)
description
string (Description)
default_branch
string or null (Default branch)
timezone
string (Timezone of the project)
region
string (Region)
default_domain
string or null (Default domain)

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "title": "string",
  • "description": "string",
  • "default_branch": "string",
  • "timezone": "string",
  • "region": "string",
  • "default_domain": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete a project

{schemes}://api.upsun.com/projects/{projectId}

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "title": "string",
  • "description": "string",
  • "default_branch": "string",
  • "timezone": "string",
  • "region": "string",
  • "default_domain": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete a project

Delete the entire project.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a project's capabilities

{schemes}://api.upsun.com/projects/{projectId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a project's capabilities

Get a list of capabilities on a project, as defined by the billing system. @@ -1229,7 +1229,7 @@

Using the Access Token

large development environments.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "custom_domains": {
    },
  • "source_operations": {
    },
  • "runtime_operations": {
    },
  • "outbound_firewall": {
    },
  • "metrics": {
    },
  • "logs_forwarding": {
    },
  • "guaranteed_resources": {
    },
  • "images": {
    },
  • "instance_limit": 0,
  • "build_resources": {
    },
  • "data_retention": {
    },
  • "autoscaling": {
    },
  • "integrations": {
    }
}

Clear project build cache

{schemes}://api.upsun.com/projects/{projectId}/capabilities

Response samples

Content type
application/json
{
  • "custom_domains": {
    },
  • "source_operations": {
    },
  • "runtime_operations": {
    },
  • "outbound_firewall": {
    },
  • "metrics": {
    },
  • "logs_forwarding": {
    },
  • "guaranteed_resources": {
    },
  • "images": {
    },
  • "instance_limit": 0,
  • "build_resources": {
    },
  • "data_retention": {
    },
  • "autoscaling": {
    },
  • "integrations": {
    }
}

Clear project build cache

On rare occasions, a project's build cache can become corrupted. This @@ -1237,7 +1237,7 @@

Using the Access Token

on clearing the build cache can be found in our user documentation.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Domain Management

{schemes}://api.upsun.com/projects/{projectId}/clear_build_cache

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Domain Management

Using the Access Token "Access site" on the user interface.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a project domain

{schemes}://api.upsun.com/projects/{projectId}/domains

Response samples

Content type
application/json
[
  • {
    }
]

Add a project domain

Authorizations:
OAuth2
path Parameters
projectId
required
string
Request Body schema: application/json
required
One of
name
required
string (Domain name)
object (Arbitrary attributes attached to this resource)
is_default
boolean (Is this domain default)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "attributes": {
    },
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a project domain

{schemes}://api.upsun.com/projects/{projectId}/domains

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "attributes": {
    },
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a project domain

Retrieve information about a single user-specified domain associated with a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
domainId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "project": "string",
  • "name": "string",
  • "registered_name": "string",
  • "attributes": {
    },
  • "is_default": true
}

Update a project domain

{schemes}://api.upsun.com/projects/{projectId}/domains/{domainId}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "project": "string",
  • "name": "string",
  • "registered_name": "string",
  • "attributes": {
    },
  • "is_default": true
}

Update a project domain

Update the information associated with a single user-specified domain associated with a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
domainId
required
string
Request Body schema: application/json
required
One of
object (Arbitrary attributes attached to this resource)
is_default
boolean (Is this domain default)

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete a project domain

{schemes}://api.upsun.com/projects/{projectId}/domains/{domainId}

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete a project domain

Delete a single user-specified domain associated with a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
domainId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a list of environment domains

{schemes}://api.upsun.com/projects/{projectId}/domains/{domainId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a list of environment domains

Using the Access Token the environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add an environment domain

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/domains

Response samples

Content type
application/json
[
  • {
    }
]

Add an environment domain

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
One of
name
required
string (Domain name)
object (Arbitrary attributes attached to this resource)
is_default
boolean (Is this domain default)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "attributes": {
    },
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get an environment domain

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/domains

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "attributes": {
    },
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get an environment domain

Retrieve information about a single user-specified domain associated with an environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
domainId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "project": "string",
  • "name": "string",
  • "registered_name": "string",
  • "attributes": {
    },
  • "is_default": true
}

Update an environment domain

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/domains/{domainId}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "project": "string",
  • "name": "string",
  • "registered_name": "string",
  • "attributes": {
    },
  • "is_default": true
}

Update an environment domain

Update the information associated with a single user-specified domain associated with an environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
domainId
required
string
Request Body schema: application/json
required
One of
object (Arbitrary attributes attached to this resource)
is_default
boolean (Is this domain default)

Responses

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an environment domain

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/domains/{domainId}

Request samples

Content type
application/json
Example
{
  • "attributes": {
    },
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an environment domain

Delete a single user-specified domain associated with an environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
domainId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Cert Management

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/domains/{domainId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Cert Management

Using the Access Token associated with a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add an SSL certificate

{schemes}://api.upsun.com/projects/{projectId}/certificates

Response samples

Content type
application/json
[
  • {
    }
]

Add an SSL certificate

Add a single SSL certificate to a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
Request Body schema: application/json
required
certificate
required
string (The PEM-encoded certificate)
key
required
string (The PEM-encoded private key)
chain
Array of strings (Certificate chain)
is_invalid
boolean (Whether this certificate should be skipped during provisioning)

Responses

Request samples

Content type
application/json
{
  • "certificate": "string",
  • "key": "string",
  • "chain": [
    ],
  • "is_invalid": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get an SSL certificate

{schemes}://api.upsun.com/projects/{projectId}/certificates

Request samples

Content type
application/json
{
  • "certificate": "string",
  • "key": "string",
  • "chain": [
    ],
  • "is_invalid": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get an SSL certificate

Retrieve information about a single SSL certificate associated with a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
certificateId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "certificate": "string",
  • "chain": [
    ],
  • "is_provisioned": true,
  • "is_invalid": true,
  • "is_root": true,
  • "domains": [
    ],
  • "auth_type": [
    ],
  • "issuer": [
    ],
  • "expires_at": "2019-08-24T14:15:22Z"
}

Update an SSL certificate

{schemes}://api.upsun.com/projects/{projectId}/certificates/{certificateId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "certificate": "string",
  • "chain": [
    ],
  • "is_provisioned": true,
  • "is_invalid": true,
  • "is_root": true,
  • "domains": [
    ],
  • "auth_type": [
    ],
  • "issuer": [
    ],
  • "expires_at": "2019-08-24T14:15:22Z"
}

Update an SSL certificate

Update a single SSL certificate associated with a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
certificateId
required
string
Request Body schema: application/json
required
chain
Array of strings (Certificate chain)
is_invalid
boolean (Whether this certificate should be skipped during provisioning)

Responses

Request samples

Content type
application/json
{
  • "chain": [
    ],
  • "is_invalid": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an SSL certificate

{schemes}://api.upsun.com/projects/{projectId}/certificates/{certificateId}

Request samples

Content type
application/json
{
  • "chain": [
    ],
  • "is_invalid": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an SSL certificate

Delete a single SSL certificate associated with a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
certificateId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Project Variables

{schemes}://api.upsun.com/projects/{projectId}/certificates/{certificateId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Project Variables

Using the Access Token within a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a project variable

{schemes}://api.upsun.com/projects/{projectId}/variables

Response samples

Content type
application/json
[
  • {
    }
]

Add a project variable

Using the Access Token section in our documentation for more information.

Authorizations:
OAuth2
path Parameters
projectId
required
string
Request Body schema: application/json
required
name
required
string (Name)
value
required
string (Value)
object (Arbitrary attributes attached to this resource)
is_json
boolean (The variable is a JSON string)
is_sensitive
boolean (The variable is sensitive)
visible_build
boolean (The variable is visible during build)
visible_runtime
boolean (The variable is visible at runtime)
application_scope
Array of strings (Applications that have access to this variable)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a project variable

{schemes}://api.upsun.com/projects/{projectId}/variables

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a project variable

Retrieve a single user-defined project variable.

Authorizations:
OAuth2
path Parameters
projectId
required
string
projectVariableId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ]
}

Update a project variable

{schemes}://api.upsun.com/projects/{projectId}/variables/{projectVariableId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ]
}

Update a project variable

Using the Access Token section in our documentation for more information.

Authorizations:
OAuth2
path Parameters
projectId
required
string
projectVariableId
required
string
Request Body schema: application/json
required
name
string (Name)
object (Arbitrary attributes attached to this resource)
value
string (Value)
is_json
boolean (The variable is a JSON string)
is_sensitive
boolean (The variable is sensitive)
visible_build
boolean (The variable is visible during build)
visible_runtime
boolean (The variable is visible at runtime)
application_scope
Array of strings (Applications that have access to this variable)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete a project variable

{schemes}://api.upsun.com/projects/{projectId}/variables/{projectVariableId}

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete a project variable

Delete a single user-defined project variable.

Authorizations:
OAuth2
path Parameters
projectId
required
string
projectVariableId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Repository

{schemes}://api.upsun.com/projects/{projectId}/variables/{projectVariableId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Repository

Using the Access Token format in the encoding field, e.g. base64.

Authorizations:
OAuth2
path Parameters
projectId
required
string
repositoryBlobId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "sha": "string",
  • "size": 0,
  • "encoding": "base64",
  • "content": "string"
}

Get a commit object

{schemes}://api.upsun.com/projects/{projectId}/git/blobs/{repositoryBlobId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "sha": "string",
  • "size": 0,
  • "encoding": "base64",
  • "content": "string"
}

Get a commit object

Using the Access Token endpoint.

Authorizations:
OAuth2
path Parameters
projectId
required
string
repositoryCommitId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "sha": "string",
  • "author": {
    },
  • "committer": {
    },
  • "message": "string",
  • "tree": "string",
  • "parents": [
    ]
}

Get list of repository refs

{schemes}://api.upsun.com/projects/{projectId}/git/commits/{repositoryCommitId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "sha": "string",
  • "author": {
    },
  • "committer": {
    },
  • "message": "string",
  • "tree": "string",
  • "parents": [
    ]
}

Get list of repository refs

Using the Access Token endpoint to retrieve information about that specific commit.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a ref object

{schemes}://api.upsun.com/projects/{projectId}/git/refs

Response samples

Content type
application/json
[
  • {
    }
]

Get a ref object

Using the Access Token /projects/{projectId}/git/refs/heads%2Fmaster.

Authorizations:
OAuth2
path Parameters
projectId
required
string
repositoryRefId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ref": "string",
  • "object": {
    },
  • "sha": "string"
}

Get a tree object

{schemes}://api.upsun.com/projects/{projectId}/git/refs/{repositoryRefId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ref": "string",
  • "object": {
    },
  • "sha": "string"
}

Get a tree object

Using the Access Token endpoint.

Authorizations:
OAuth2
path Parameters
projectId
required
string
repositoryTreeId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "sha": "string",
  • "tree": [
    ]
}

Third-Party Integrations

{schemes}://api.upsun.com/projects/{projectId}/git/trees/{repositoryTreeId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "sha": "string",
  • "tree": [
    ]
}

Third-Party Integrations

Using the Access Token required body fields in the API request.

Get list of existing integrations for a project

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Integrate project with a third-party service

Authorizations:
OAuth2
path Parameters
projectId
required
string
Request Body schema: application/json
required
One of
type
required
string (Integration type)
repository
required
string (The Bitbucket repository (in the form `user/repo`).)
fetch_branches
boolean (Whether or not to fetch branches.)
prune_branches
boolean (Whether or not to remove branches that disappeared remotely (requires `fetch_branches`).)
environment_init_resources
string (The resources used when initializing a new service)
Enum: "default" "manual" "minimum" "parent"
object or null (The OAuth2 consumer information (optional).)
object or null (The addon credential information (optional).)
build_pull_requests
boolean (Whether or not to build pull requests.)
pull_requests_clone_parent_data
boolean (Whether or not to clone parent data when building merge requests.)
resync_pull_requests
boolean (Whether or not pull request environment data should be re-synced on every build.)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Integrate project with a third-party service

Authorizations:
OAuth2
path Parameters
projectId
required
string
Request Body schema: application/json
required
One of
type
required
string (Integration type)
repository
required
string (The Bitbucket repository (in the form `user/repo`).)
fetch_branches
boolean (Whether or not to fetch branches.)
prune_branches
boolean (Whether or not to remove branches that disappeared remotely (requires `fetch_branches`).)
environment_init_resources
string (The resources used when initializing a new service)
Enum: "default" "manual" "minimum" "parent"
object or null (The OAuth2 consumer information (optional).)
object or null (The addon credential information (optional).)
build_pull_requests
boolean (Whether or not to build pull requests.)
pull_requests_clone_parent_data
boolean (Whether or not to clone parent data when building merge requests.)
resync_pull_requests
boolean (Whether or not pull request environment data should be re-synced on every build.)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "string",
  • "fetch_branches": true,
  • "prune_branches": true,
  • "environment_init_resources": "default",
  • "app_credentials": {
    },
  • "addon_credentials": {
    },
  • "repository": "string",
  • "build_pull_requests": true,
  • "pull_requests_clone_parent_data": true,
  • "resync_pull_requests": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get information about an existing third-party integration

Authorizations:
OAuth2
path Parameters
projectId
required
string
integrationId
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "type": "string",
  • "fetch_branches": true,
  • "prune_branches": true,
  • "environment_init_resources": "default",
  • "app_credentials": {
    },
  • "addon_credentials": {
    },
  • "repository": "string",
  • "build_pull_requests": true,
  • "pull_requests_clone_parent_data": true,
  • "resync_pull_requests": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get information about an existing third-party integration

Authorizations:
OAuth2
path Parameters
projectId
required
string
integrationId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "fetch_branches": true,
  • "prune_branches": true,
  • "environment_init_resources": "default",
  • "app_credentials": {
    },
  • "addon_credentials": {
    },
  • "repository": "string",
  • "build_pull_requests": true,
  • "pull_requests_clone_parent_data": true,
  • "resync_pull_requests": true
}

Update an existing third-party integration

Authorizations:
OAuth2
path Parameters
projectId
required
string
integrationId
required
string
Request Body schema: application/json
required
One of
type
required
string (Integration type)
repository
required
string (The Bitbucket repository (in the form `user/repo`).)
fetch_branches
boolean (Whether or not to fetch branches.)
prune_branches
boolean (Whether or not to remove branches that disappeared remotely (requires `fetch_branches`).)
environment_init_resources
string (The resources used when initializing a new service)
Enum: "default" "manual" "minimum" "parent"
object or null (The OAuth2 consumer information (optional).)
object or null (The addon credential information (optional).)
build_pull_requests
boolean (Whether or not to build pull requests.)
pull_requests_clone_parent_data
boolean (Whether or not to clone parent data when building merge requests.)
resync_pull_requests
boolean (Whether or not pull request environment data should be re-synced on every build.)

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "fetch_branches": true,
  • "prune_branches": true,
  • "environment_init_resources": "default",
  • "app_credentials": {
    },
  • "addon_credentials": {
    },
  • "repository": "string",
  • "build_pull_requests": true,
  • "pull_requests_clone_parent_data": true,
  • "resync_pull_requests": true
}

Update an existing third-party integration

Authorizations:
OAuth2
path Parameters
projectId
required
string
integrationId
required
string
Request Body schema: application/json
required
One of
type
required
string (Integration type)
repository
required
string (The Bitbucket repository (in the form `user/repo`).)
fetch_branches
boolean (Whether or not to fetch branches.)
prune_branches
boolean (Whether or not to remove branches that disappeared remotely (requires `fetch_branches`).)
environment_init_resources
string (The resources used when initializing a new service)
Enum: "default" "manual" "minimum" "parent"
object or null (The OAuth2 consumer information (optional).)
object or null (The addon credential information (optional).)
build_pull_requests
boolean (Whether or not to build pull requests.)
pull_requests_clone_parent_data
boolean (Whether or not to clone parent data when building merge requests.)
resync_pull_requests
boolean (Whether or not pull request environment data should be re-synced on every build.)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "string",
  • "fetch_branches": true,
  • "prune_branches": true,
  • "environment_init_resources": "default",
  • "app_credentials": {
    },
  • "addon_credentials": {
    },
  • "repository": "string",
  • "build_pull_requests": true,
  • "pull_requests_clone_parent_data": true,
  • "resync_pull_requests": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an existing third-party integration

Authorizations:
OAuth2
path Parameters
projectId
required
string
integrationId
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "type": "string",
  • "fetch_branches": true,
  • "prune_branches": true,
  • "environment_init_resources": "default",
  • "app_credentials": {
    },
  • "addon_credentials": {
    },
  • "repository": "string",
  • "build_pull_requests": true,
  • "pull_requests_clone_parent_data": true,
  • "resync_pull_requests": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an existing third-party integration

Authorizations:
OAuth2
path Parameters
projectId
required
string
integrationId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Support

{schemes}://api.upsun.com/projects/{projectId}/integrations/{integrationId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Support

These endpoints can be used to retrieve information about support ticket priority and allow you to submit new ticket to the Upsun Support Team.

@@ -1553,7 +1553,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

A Support Ticket object

Request samples

Content type
application/json
{
  • "subject": "string",
  • "description": "string",
  • "requester_id": "5fe88a55-c92f-4e12-bd25-87bf15036ce9",
  • "priority": "low",
  • "subscription_id": "string",
  • "organization_id": "string",
  • "affected_url": "string",
  • "followup_tid": "string",
  • "category": "access",
  • "attachments": [
    ],
  • "collaborator_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "ticket_id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "type": "problem",
  • "subject": "string",
  • "description": "string",
  • "priority": "low",
  • "followup_tid": "string",
  • "status": "closed",
  • "recipient": "string",
  • "requester_id": "5fe88a55-c92f-4e12-bd25-87bf15036ce9",
  • "submitter_id": "7e359385-67b1-4c24-8530-73be9a04faec",
  • "assignee_id": "e209ca2d-190b-4818-b659-67d4ef4f1ce8",
  • "organization_id": "string",
  • "collaborator_ids": [
    ],
  • "has_incidents": true,
  • "due": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "subscription_id": "string",
  • "ticket_group": "string",
  • "support_plan": "string",
  • "affected_url": "string",
  • "queue": "string",
  • "issue_type": "string",
  • "resolution_time": "2019-08-24T14:15:22Z",
  • "response_time": "2019-08-24T14:15:22Z",
  • "project_url": "string",
  • "region": "string",
  • "category": "access",
  • "environment": "env_development",
  • "ticket_sharing_status": "ts_sent_to_platform",
  • "application_ticket_url": "string",
  • "infrastructure_ticket_url": "string",
  • "jira": [
    ],
  • "zd_ticket_url": "string"
}

Update a ticket

Authorizations:
OAuth2
path Parameters
ticket_id
required
string
{schemes}://api.upsun.com/tickets

Request samples

Content type
application/json
{
  • "subject": "string",
  • "description": "string",
  • "requester_id": "5fe88a55-c92f-4e12-bd25-87bf15036ce9",
  • "priority": "low",
  • "subscription_id": "string",
  • "organization_id": "string",
  • "affected_url": "string",
  • "followup_tid": "string",
  • "category": "access",
  • "attachments": [
    ],
  • "collaborator_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "ticket_id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "type": "problem",
  • "subject": "string",
  • "description": "string",
  • "priority": "low",
  • "followup_tid": "string",
  • "status": "closed",
  • "recipient": "string",
  • "requester_id": "5fe88a55-c92f-4e12-bd25-87bf15036ce9",
  • "submitter_id": "7e359385-67b1-4c24-8530-73be9a04faec",
  • "assignee_id": "e209ca2d-190b-4818-b659-67d4ef4f1ce8",
  • "organization_id": "string",
  • "collaborator_ids": [
    ],
  • "has_incidents": true,
  • "due": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "subscription_id": "string",
  • "ticket_group": "string",
  • "support_plan": "string",
  • "affected_url": "string",
  • "queue": "string",
  • "issue_type": "string",
  • "resolution_time": "2019-08-24T14:15:22Z",
  • "response_time": "2019-08-24T14:15:22Z",
  • "project_url": "string",
  • "region": "string",
  • "category": "access",
  • "environment": "env_development",
  • "ticket_sharing_status": "ts_sent_to_platform",
  • "application_ticket_url": "string",
  • "infrastructure_ticket_url": "string",
  • "jira": [
    ],
  • "zd_ticket_url": "string"
}

Update a ticket

Authorizations:
OAuth2
path Parameters
ticket_id
required
string

The ID of the ticket

Request Body schema: application/json
status
string
Enum: "open" "solved"

The status of the support ticket.

@@ -1567,7 +1567,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

The ticket was not updated.

Request samples

Content type
application/json
{
  • "status": "open",
  • "collaborator_ids": [
    ],
  • "collaborators_replace": null
}

Response samples

Content type
application/json
{
  • "ticket_id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "type": "problem",
  • "subject": "string",
  • "description": "string",
  • "priority": "low",
  • "followup_tid": "string",
  • "status": "closed",
  • "recipient": "string",
  • "requester_id": "5fe88a55-c92f-4e12-bd25-87bf15036ce9",
  • "submitter_id": "7e359385-67b1-4c24-8530-73be9a04faec",
  • "assignee_id": "e209ca2d-190b-4818-b659-67d4ef4f1ce8",
  • "organization_id": "string",
  • "collaborator_ids": [
    ],
  • "has_incidents": true,
  • "due": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "subscription_id": "string",
  • "ticket_group": "string",
  • "support_plan": "string",
  • "affected_url": "string",
  • "queue": "string",
  • "issue_type": "string",
  • "resolution_time": "2019-08-24T14:15:22Z",
  • "response_time": "2019-08-24T14:15:22Z",
  • "project_url": "string",
  • "region": "string",
  • "category": "access",
  • "environment": "env_development",
  • "ticket_sharing_status": "ts_sent_to_platform",
  • "application_ticket_url": "string",
  • "infrastructure_ticket_url": "string",
  • "jira": [
    ],
  • "zd_ticket_url": "string"
}

List support ticket priorities

Authorizations:
OAuth2
query Parameters
subscription_id
string
{schemes}://api.upsun.com/tickets/{ticket_id}

Request samples

Content type
application/json
{
  • "status": "open",
  • "collaborator_ids": [
    ],
  • "collaborators_replace": null
}

Response samples

Content type
application/json
{
  • "ticket_id": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "type": "problem",
  • "subject": "string",
  • "description": "string",
  • "priority": "low",
  • "followup_tid": "string",
  • "status": "closed",
  • "recipient": "string",
  • "requester_id": "5fe88a55-c92f-4e12-bd25-87bf15036ce9",
  • "submitter_id": "7e359385-67b1-4c24-8530-73be9a04faec",
  • "assignee_id": "e209ca2d-190b-4818-b659-67d4ef4f1ce8",
  • "organization_id": "string",
  • "collaborator_ids": [
    ],
  • "has_incidents": true,
  • "due": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "subscription_id": "string",
  • "ticket_group": "string",
  • "support_plan": "string",
  • "affected_url": "string",
  • "queue": "string",
  • "issue_type": "string",
  • "resolution_time": "2019-08-24T14:15:22Z",
  • "response_time": "2019-08-24T14:15:22Z",
  • "project_url": "string",
  • "region": "string",
  • "category": "access",
  • "environment": "env_development",
  • "ticket_sharing_status": "ts_sent_to_platform",
  • "application_ticket_url": "string",
  • "infrastructure_ticket_url": "string",
  • "jira": [
    ],
  • "zd_ticket_url": "string"
}

List support ticket priorities

Authorizations:
OAuth2
query Parameters
subscription_id
string

The ID of the subscription the ticket should be related to

category
string

The category of the support ticket.

@@ -1575,7 +1575,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

An array of available priorities for that license.

Response samples

Content type
application/json
[
  • {
    }
]

List support ticket categories

Authorizations:
OAuth2
query Parameters
subscription_id
string
{schemes}://api.upsun.com/tickets/priority

Response samples

Content type
application/json
[
  • {
    }
]

List support ticket categories

Authorizations:
OAuth2
query Parameters
subscription_id
string

The ID of the subscription the ticket should be related to

organization_id
string

The ID of the organization the ticket should be related to

@@ -1583,7 +1583,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

An array of available categories for a ticket.

Response samples

Content type
application/json
[
  • {
    }
]

Environment

{schemes}://api.upsun.com/tickets/category

Response samples

Content type
application/json
[
  • {
    }
]

Environment

Using the Access Token information associated with each environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an environment

{schemes}://api.upsun.com/projects/{projectId}/environments

Response samples

Content type
application/json
[
  • {
    }
]

Get an environment

Retrieve the details of a single existing environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "machine_name": "string",
  • "title": "string",
  • "attributes": {
    },
  • "type": "development",
  • "parent": "string",
  • "default_domain": "string",
  • "has_domains": true,
  • "clone_parent_on_create": true,
  • "deployment_target": "string",
  • "is_pr": true,
  • "has_remote": true,
  • "status": "active",
  • "http_access": {
    },
  • "enable_smtp": true,
  • "restrict_robots": true,
  • "edge_hostname": "string",
  • "deployment_state": {
    },
  • "sizing": {
    },
  • "resources_overrides": {
    },
  • "max_instance_count": 0,
  • "last_active_at": "2019-08-24T14:15:22Z",
  • "last_backup_at": "2019-08-24T14:15:22Z",
  • "project": "string",
  • "is_main": true,
  • "is_dirty": true,
  • "has_staged_activities": true,
  • "can_rolling_deploy": true,
  • "has_code": true,
  • "head_commit": "string",
  • "merge_info": {
    },
  • "has_deployment": true,
  • "supports_restrict_robots": true
}

Update an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "machine_name": "string",
  • "title": "string",
  • "attributes": {
    },
  • "type": "development",
  • "parent": "string",
  • "default_domain": "string",
  • "has_domains": true,
  • "clone_parent_on_create": true,
  • "deployment_target": "string",
  • "is_pr": true,
  • "has_remote": true,
  • "status": "active",
  • "http_access": {
    },
  • "enable_smtp": true,
  • "restrict_robots": true,
  • "edge_hostname": "string",
  • "deployment_state": {
    },
  • "sizing": {
    },
  • "resources_overrides": {
    },
  • "max_instance_count": 0,
  • "last_active_at": "2019-08-24T14:15:22Z",
  • "last_backup_at": "2019-08-24T14:15:22Z",
  • "project": "string",
  • "is_main": true,
  • "is_dirty": true,
  • "has_staged_activities": true,
  • "can_rolling_deploy": true,
  • "supports_rolling_deployments": true,
  • "has_code": true,
  • "head_commit": "string",
  • "merge_info": {
    },
  • "has_deployment": true,
  • "supports_restrict_robots": true
}

Update an environment

Update the details of a single existing environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
name
string (Name)
title
string (Title)
object (Arbitrary attributes attached to this resource)
type
string (The type of environment (`production`, `staging` or `development`). If not provided, a default will be calculated.)
Enum: "development" "production" "staging"
parent
string or null (Parent environment)
clone_parent_on_create
boolean (Clone data when creating that environment)
object (HTTP access permissions)
enable_smtp
boolean (Whether to configure SMTP for this environment.)
restrict_robots
boolean (Whether to restrict robots for this environment.)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "attributes": {
    },
  • "type": "development",
  • "parent": "string",
  • "clone_parent_on_create": true,
  • "http_access": {
    },
  • "enable_smtp": true,
  • "restrict_robots": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "attributes": {
    },
  • "type": "development",
  • "parent": "string",
  • "clone_parent_on_create": true,
  • "http_access": {
    },
  • "enable_smtp": true,
  • "restrict_robots": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an environment

Delete a specified environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Activate an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Activate an environment

Set the specified environment's status to active

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
required
object or null (Resources)

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Branch an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/activate

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Branch an environment

Create a new environment as a branch of the current environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
title
required
string (Title)
name
required
string (Name)
clone_parent
required
boolean (Clone data from the parent environment)
type
required
string (The type of environment (`staging` or `development`))
Enum: "development" "staging"
required
object or null (Resources)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "name": "string",
  • "clone_parent": true,
  • "type": "development",
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Deactivate an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/branch

Request samples

Content type
application/json
{
  • "title": "string",
  • "name": "string",
  • "clone_parent": true,
  • "type": "development",
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Deactivate an environment

Using the Access Token

NOTE: ALL DATA IN THIS ENVIRONMENT WILL BE IRREVOCABLY LOST

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Deploy an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/deactivate

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Deploy an environment

Trigger a controlled manual deployment to release all the staged changes

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
strategy
required
string (The deployment strategy (`rolling` or `stopstart`))
Enum: "rolling" "stopstart"

Responses

Request samples

Content type
application/json
{
  • "strategy": "rolling"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Initialize a new environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/deploy

Request samples

Content type
application/json
{
  • "strategy": "rolling"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Initialize a new environment

Using the Access Token YAML configuration files in another.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
profile
required
string (Name of the profile to show in the UI)
repository
required
string (Repository to clone from)
config
required
string or null (Repository to clone the configuration files from)
required
Array of objects (A list of files to add to the repository during initialization)
required
object or null (Resources)

Responses

Request samples

Content type
application/json
{
  • "profile": "string",
  • "repository": "string",
  • "config": "string",
  • "files": [
    ],
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Merge an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/initialize

Request samples

Content type
application/json
{
  • "profile": "string",
  • "repository": "string",
  • "config": "string",
  • "files": [
    ],
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Merge an environment

Using the Access Token retaining the existing data in the parent environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
required
object or null (Resources)

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Pause an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/merge

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Pause an environment

Using the Access Token information is available in our public documentation.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Redeploy an environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/pause

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Redeploy an environment

Trigger the redeployment sequence of an environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Resume a paused environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/redeploy

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Resume a paused environment

Using the Access Token endpoint or the CLI as described in the public documentation.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Synchronize a child environment with its parent

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/resume

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Synchronize a child environment with its parent

Using the Access Token be overwritten with that of its parent.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
synchronize_code
required
boolean (Synchronize code?)
rebase
required
boolean (Synchronize code by rebasing instead of merging)
synchronize_data
required
boolean (Synchronize data?)
synchronize_resources
required
boolean (Synchronize resources?)

Responses

Request samples

Content type
application/json
{
  • "synchronize_code": true,
  • "rebase": true,
  • "synchronize_data": true,
  • "synchronize_resources": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

List versions associated with the environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/synchronize

Request samples

Content type
application/json
{
  • "synchronize_code": true,
  • "rebase": true,
  • "synchronize_data": true,
  • "synchronize_resources": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

List versions associated with the environment

Using the Access Token The deployment target type denotes whether staged deployment is supported.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create versions associated with the environment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/versions

Response samples

Content type
application/json
[
  • {
    }
]

Create versions associated with the environment

Using the Access Token The deployment target type denotes whether staged deployment is supported.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
object (Configuration about the traffic routed to this version)

Responses

Request samples

Content type
application/json
{
  • "routing": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

List the version

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/versions

Request samples

Content type
application/json
{
  • "routing": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

List the version

List the {versionId} version. @@ -1767,7 +1767,7 @@

Using the Access Token

(if the deployment target supports it).

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
versionId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "commit": "string",
  • "locked": true,
  • "routing": {
    }
}

Update the version

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/versions/{versionId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "commit": "string",
  • "locked": true,
  • "routing": {
    }
}

Update the version

Update the {versionId} version. @@ -1775,7 +1775,7 @@

Using the Access Token

(if the deployment target supports it).

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
versionId
required
string
Request Body schema: application/json
required
object (Configuration about the traffic routed to this version)

Responses

Request samples

Content type
application/json
{
  • "routing": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete the version

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/versions/{versionId}

Request samples

Content type
application/json
{
  • "routing": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete the version

Delete the {versionId} version. @@ -1783,7 +1783,7 @@

Using the Access Token

(if the deployment target supports it).

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
versionId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Environment Backups

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/versions/{versionId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Environment Backups

Using the Access Token section of the documentation for more information.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
safe
required
boolean (Take a safe or a live backup)

Responses

Request samples

Content type
application/json
{
  • "safe": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get an environment's backup list

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/backup

Request samples

Content type
application/json
{
  • "safe": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get an environment's backup list

Retrieve a list of objects representing backups of this environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an environment backup's info

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/backups

Response samples

Content type
application/json
[
  • {
    }
]

Get an environment backup's info

Using the Access Token endpoint.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
backupId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "attributes": {
    },
  • "status": "CREATED",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "index": 0,
  • "commit_id": "string",
  • "environment": "string",
  • "safe": true,
  • "size_of_volumes": 0,
  • "size_used": 0,
  • "deployment": "string",
  • "restorable": true,
  • "automated": true
}

Delete an environment backup

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/backups/{backupId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "attributes": {
    },
  • "status": "CREATED",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "index": 0,
  • "commit_id": "string",
  • "environment": "string",
  • "safe": true,
  • "size_of_volumes": 0,
  • "size_used": 0,
  • "deployment": "string",
  • "restorable": true,
  • "automated": true
}

Delete an environment backup

Using the Access Token endpoint.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
backupId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Restore an environment snapshot

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/backups/{backupId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Restore an environment snapshot

Using the Access Token endpoint.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
backupId
required
string
Request Body schema: application/json
required
environment_name
required
string or null (Environment name)
branch_from
required
string or null (Branch from)
restore_code
required
boolean (Whether we should restore the code or only the data)
restore_resources
required
boolean (Whether we should restore resources configuration from the backup)
required
object or null (Resources)

Responses

Request samples

Content type
application/json
{
  • "environment_name": "string",
  • "branch_from": "string",
  • "restore_code": true,
  • "restore_resources": true,
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Environment Variables

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/backups/{backupId}/restore

Request samples

Content type
application/json
{
  • "environment_name": "string",
  • "branch_from": "string",
  • "restore_code": true,
  • "restore_resources": true,
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Environment Variables

Using the Access Token within an environment.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add an environment variable

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/variables

Response samples

Content type
application/json
[
  • {
    }
]

Add an environment variable

Using the Access Token section in our documentation for more information.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
name
required
string (Name)
value
required
string (Value)
object (Arbitrary attributes attached to this resource)
is_json
boolean (The variable is a JSON string)
is_sensitive
boolean (The variable is sensitive)
visible_build
boolean (The variable is visible during build)
visible_runtime
boolean (The variable is visible at runtime)
application_scope
Array of strings (Applications that have access to this variable)
is_enabled
boolean (The variable is enabled on this environment)
is_inheritable
boolean (The variable is inheritable to child environments)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ],
  • "is_enabled": true,
  • "is_inheritable": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get an environment variable

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/variables

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ],
  • "is_enabled": true,
  • "is_inheritable": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get an environment variable

Retrieve a single user-defined environment variable.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
variableId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ],
  • "project": "string",
  • "environment": "string",
  • "inherited": true,
  • "is_enabled": true,
  • "is_inheritable": true
}

Update an environment variable

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/variables/{variableId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ],
  • "project": "string",
  • "environment": "string",
  • "inherited": true,
  • "is_enabled": true,
  • "is_inheritable": true
}

Update an environment variable

Using the Access Token section in our documentation for more information.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
variableId
required
string
Request Body schema: application/json
required
name
string (Name)
object (Arbitrary attributes attached to this resource)
value
string (Value)
is_json
boolean (The variable is a JSON string)
is_sensitive
boolean (The variable is sensitive)
visible_build
boolean (The variable is visible during build)
visible_runtime
boolean (The variable is visible at runtime)
application_scope
Array of strings (Applications that have access to this variable)
is_enabled
boolean (The variable is enabled on this environment)
is_inheritable
boolean (The variable is inheritable to child environments)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ],
  • "is_enabled": true,
  • "is_inheritable": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an environment variable

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/variables/{variableId}

Request samples

Content type
application/json
{
  • "name": "string",
  • "attributes": {
    },
  • "value": "string",
  • "is_json": true,
  • "is_sensitive": true,
  • "visible_build": true,
  • "visible_runtime": true,
  • "application_scope": [
    ],
  • "is_enabled": true,
  • "is_inheritable": true
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete an environment variable

Delete a single user-defined environment variable.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
variableId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Routing

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/variables/{variableId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Routing

Using the Access Token are those present in an environment's .upsun/config.yaml file.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a route's info

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/routes

Response samples

Content type
application/json
[
  • {
    }
]

Get a route's info

Get details of a route from an environment using the id of the entry @@ -1923,7 +1923,7 @@

Using the Access Token

endpoint.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
routeId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "primary": true,
  • "production_url": "string",
  • "attributes": {
    },
  • "type": "proxy",
  • "tls": {
    },
  • "to": "string"
}

Source Operations

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/routes/{routeId}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "primary": true,
  • "production_url": "string",
  • "attributes": {
    },
  • "type": "proxy",
  • "tls": {
    },
  • "to": "string"
}

Source Operations

Using the Access Token available in our user documentation.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
Request Body schema: application/json
required
operation
required
string (The name of the operation to execute)
required
object (The variables of the application.)

Responses

Request samples

Content type
application/json
{
  • "operation": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

List source operations

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/source-operation

Request samples

Content type
application/json
{
  • "operation": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

List source operations

Lists all the source operations, defined in .upsun/config.yaml, that are available in an environment. @@ -1949,11 +1949,11 @@

Using the Access Token

available in our user documentation.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Runtime Operations

Execute a runtime operation

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/source-operations

Response samples

Content type
application/json
[
  • {
    }
]

Runtime Operations

Execute a runtime operation

Execute a runtime operation on a currently deployed environment. This allows you to run one-off commands, such as rebuilding static assets on demand, by defining an operations key in a project's .upsun/config.yaml configuration. More information on runtime operations is available in our user documentation.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
deploymentId
required
string
Request Body schema: application/json
required
service
required
string (The name of the application or worker to run the operation on)
operation
required
string (The name of the operation)
parameters
required
Array of strings (The parameters to run the operation with)

Responses

Request samples

Content type
application/json
{
  • "service": "string",
  • "operation": "string",
  • "parameters": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Deployment

Get an environment's deployment information

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}/operations

Request samples

Content type
application/json
{
  • "service": "string",
  • "operation": "string",
  • "parameters": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Deployment

Get an environment's deployment information

Using the Access Token in the future.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a single environment deployment

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/deployments

Response samples

Content type
application/json
[
  • {
    }
]

Get a single environment deployment

Retrieve a single deployment configuration with an id of current. This may be subject to change in the future. Only current can be queried.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
deploymentId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "fingerprint": "string",
  • "cluster_name": "string",
  • "project_info": {
    },
  • "environment_info": {
    },
  • "deployment_target": "string",
  • "vpn": {
    },
  • "http_access": {
    },
  • "enable_smtp": true,
  • "restrict_robots": true,
  • "variables": [
    ],
  • "access": [
    ],
  • "subscription": {
    },
  • "services": {
    },
  • "routes": {
    },
  • "webapps": {
    },
  • "workers": {
    },
  • "container_profiles": {
    }
}

Project Activity

Get project activity log

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/deployments/{deploymentId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "fingerprint": "string",
  • "cluster_name": "string",
  • "project_info": {
    },
  • "environment_info": {
    },
  • "deployment_target": "string",
  • "vpn": {
    },
  • "http_access": {
    },
  • "enable_smtp": true,
  • "restrict_robots": true,
  • "variables": [
    ],
  • "access": [
    ],
  • "subscription": {
    },
  • "services": {
    },
  • "routes": {
    },
  • "webapps": {
    },
  • "workers": {
    },
  • "container_profiles": {
    }
}

Project Activity

Get project activity log

Using the Access Token or environment.backup.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a project activity log entry

{schemes}://api.upsun.com/projects/{projectId}/activities

Response samples

Content type
application/json
[
  • {
    }
]

Get a project activity log entry

Using the Access Token the information this endpoint can return.

Authorizations:
OAuth2
path Parameters
projectId
required
string
activityId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "parameters": { },
  • "project": "string",
  • "integration": "string",
  • "environments": [
    ],
  • "state": "cancelled",
  • "result": "failure",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "completion_percent": 0,
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "timings": {
    },
  • "log": "string",
  • "payload": { },
  • "description": "string",
  • "text": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "commands": [
    ]
}

Cancel a project activity

{schemes}://api.upsun.com/projects/{projectId}/activities/{activityId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "parameters": { },
  • "project": "string",
  • "integration": "string",
  • "environments": [
    ],
  • "state": "cancelled",
  • "result": "failure",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "completion_percent": 0,
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "timings": {
    },
  • "log": "string",
  • "payload": { },
  • "description": "string",
  • "text": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "commands": [
    ]
}

Cancel a project activity

Using the Access Token

Please note that not all activities are cancelable.

Authorizations:
OAuth2
path Parameters
projectId
required
string
activityId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Environment Activity

Get environment activity log

{schemes}://api.upsun.com/projects/{projectId}/activities/{activityId}/cancel

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Environment Activity

Get environment activity log

Using the Access Token
Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an environment activity log entry

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/activities

Response samples

Content type
application/json
[
  • {
    }
]

Get an environment activity log entry

Using the Access Token the information this endpoint can return.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
activityId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "parameters": { },
  • "project": "string",
  • "integration": "string",
  • "environments": [
    ],
  • "state": "cancelled",
  • "result": "failure",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "completion_percent": 0,
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "timings": {
    },
  • "log": "string",
  • "payload": { },
  • "description": "string",
  • "text": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "commands": [
    ]
}

Cancel an environment activity

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/activities/{activityId}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "parameters": { },
  • "project": "string",
  • "integration": "string",
  • "environments": [
    ],
  • "state": "cancelled",
  • "result": "failure",
  • "started_at": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "completion_percent": 0,
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "timings": {
    },
  • "log": "string",
  • "payload": { },
  • "description": "string",
  • "text": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "commands": [
    ]
}

Cancel an environment activity

Using the Access Token

Please note that not all activities are cancelable.

Authorizations:
OAuth2
path Parameters
projectId
required
string
environmentId
required
string
activityId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Project Invitations

Invite user to a project by email

{schemes}://api.upsun.com/projects/{projectId}/environments/{environmentId}/activities/{activityId}/cancel

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Project Invitations

Invite user to a project by email

Creates an invitation to a project for a user with the specified email address.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2167,7 +2167,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Conflict when there already is a pending invitation for the invitee

Request samples

Content type
application/json
{
  • "role": "admin",
  • "email": "user@example.com",
  • "permissions": [
    ],
  • "environments": [
    ],
  • "force": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "pending",
  • "project_id": "string",
  • "role": "admin",
  • "email": "user@example.com",
  • "owner": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "environments": [
    ]
}

List invitations to a project

{schemes}://api.upsun.com/projects/{project_id}/invitations

Request samples

Content type
application/json
{
  • "role": "admin",
  • "email": "user@example.com",
  • "permissions": [
    ],
  • "environments": [
    ],
  • "force": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "pending",
  • "project_id": "string",
  • "role": "admin",
  • "email": "user@example.com",
  • "owner": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "environments": [
    ]
}

List invitations to a project

Returns a list of invitations to a project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2191,7 +2191,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
[
  • {
    }
]

Cancel a pending invitation to a project

{schemes}://api.upsun.com/projects/{project_id}/invitations

Response samples

Content type
application/json
[
  • {
    }
]

Cancel a pending invitation to a project

Cancels the specified invitation.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2205,7 +2205,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Teams

List teams

{schemes}://api.upsun.com/projects/{project_id}/invitations/{invitation_id}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Teams

List teams

Retrieves a list of teams.

Authorizations:
OAuth2
query Parameters
object (StringFilter)

Allows filtering by organization_id using one or more operators.

@@ -2229,7 +2229,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0,
  • "_links": {
    }
}

Create team

{schemes}://api.upsun.com/teams

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0,
  • "_links": {
    }
}

Create team

Creates a new team.

Authorizations:
OAuth2
Request Body schema: application/json
required
organization_id
required
string <ulid>

The ID of the parent organization.

@@ -2245,7 +2245,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Request samples

Content type
application/json
{
  • "organization_id": "string",
  • "label": "string",
  • "project_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "label": "string",
  • "project_permissions": [
    ],
  • "counts": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get team

{schemes}://api.upsun.com/teams

Request samples

Content type
application/json
{
  • "organization_id": "string",
  • "label": "string",
  • "project_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "label": "string",
  • "project_permissions": [
    ],
  • "counts": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get team

Retrieves the specified team.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2257,7 +2257,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "label": "string",
  • "project_permissions": [
    ],
  • "counts": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update team

{schemes}://api.upsun.com/teams/{team_id}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "label": "string",
  • "project_permissions": [
    ],
  • "counts": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update team

Updates the specified team.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2275,7 +2275,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "label": "string",
  • "project_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "label": "string",
  • "project_permissions": [
    ],
  • "counts": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete team

{schemes}://api.upsun.com/teams/{team_id}

Request samples

Content type
application/json
{
  • "label": "string",
  • "project_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organization_id": "string",
  • "label": "string",
  • "project_permissions": [
    ],
  • "counts": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete team

Deletes the specified team.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2287,7 +2287,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

List team members

{schemes}://api.upsun.com/teams/{team_id}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

List team members

Retrieves a list of users associated with a single team.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2307,7 +2307,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Create team member

{schemes}://api.upsun.com/teams/{team_id}/members

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Create team member

Creates a new team member.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2323,7 +2323,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type
application/json
{
  • "team_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get team member

{schemes}://api.upsun.com/teams/{team_id}/members

Request samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type
application/json
{
  • "team_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get team member

Retrieves the specified team member.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2337,7 +2337,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "team_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete team member

{schemes}://api.upsun.com/teams/{team_id}/members/{user_id}

Response samples

Content type
application/json
{
  • "team_id": "string",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete team member

Deletes the specified team member.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2351,7 +2351,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

User teams

{schemes}://api.upsun.com/teams/{team_id}/members/{user_id}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

User teams

Retrieves teams that the specified user is a member of.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2377,7 +2377,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0,
  • "_links": {
    }
}

Team Access

List team access for a project

{schemes}://api.upsun.com/users/{user_id}/teams

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0,
  • "_links": {
    }
}

Team Access

List team access for a project

Returns a list of items representing the project access.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2401,7 +2401,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Grant team access to a project

{schemes}://api.upsun.com/projects/{project_id}/team-access

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Grant team access to a project

Grants one or more team access to a specific project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2415,7 +2415,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Get team access for a project

{schemes}://api.upsun.com/projects/{project_id}/team-access

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Get team access for a project

Retrieves the team's permissions for the current project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2429,7 +2429,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "team_id": "string",
  • "organization_id": "string",
  • "project_id": "string",
  • "project_title": "string",
  • "granted_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Remove team access for a project

{schemes}://api.upsun.com/projects/{project_id}/team-access/{team_id}

Response samples

Content type
application/json
{
  • "team_id": "string",
  • "organization_id": "string",
  • "project_id": "string",
  • "project_title": "string",
  • "granted_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Remove team access for a project

Removes the team from the current project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2445,7 +2445,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

List project access for a team

{schemes}://api.upsun.com/projects/{project_id}/team-access/{team_id}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

List project access for a team

Returns a list of items representing the team's project access.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2469,7 +2469,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Grant project access to a team

{schemes}://api.upsun.com/teams/{team_id}/project-access

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Grant project access to a team

Adds the team to one or more specified projects.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2483,7 +2483,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Get project access for a team

{schemes}://api.upsun.com/teams/{team_id}/project-access

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Get project access for a team

Retrieves the team's permissions for the current project.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2497,7 +2497,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "team_id": "string",
  • "organization_id": "string",
  • "project_id": "string",
  • "project_title": "string",
  • "granted_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Remove project access for a team

{schemes}://api.upsun.com/teams/{team_id}/project-access/{project_id}

Response samples

Content type
application/json
{
  • "team_id": "string",
  • "organization_id": "string",
  • "project_id": "string",
  • "project_title": "string",
  • "granted_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Remove project access for a team

Removes the team from the current project.

Authorizations:
OAuth2
path Parameters
team_id
required
string

The ID of the team.

@@ -2513,7 +2513,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

User Access

List user access for a project

{schemes}://api.upsun.com/teams/{team_id}/project-access/{project_id}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

User Access

List user access for a project

Returns a list of items representing the project access.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2537,7 +2537,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Grant user access to a project

{schemes}://api.upsun.com/projects/{project_id}/user-access

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Grant user access to a project

Grants one or more users access to a specific project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2555,7 +2555,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Get user access for a project

{schemes}://api.upsun.com/projects/{project_id}/user-access

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Get user access for a project

Retrieves the user's permissions for the current project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2569,7 +2569,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "organization_id": "string",
  • "project_id": "string",
  • "project_title": "string",
  • "permissions": [
    ],
  • "granted_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update user access for a project

{schemes}://api.upsun.com/projects/{project_id}/user-access/{user_id}

Response samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "organization_id": "string",
  • "project_id": "string",
  • "project_title": "string",
  • "permissions": [
    ],
  • "granted_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update user access for a project

Updates the user's permissions for the current project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2587,7 +2587,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Remove user access for a project

{schemes}://api.upsun.com/projects/{project_id}/user-access/{user_id}

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Remove user access for a project

Removes the user from the current project.

Authorizations:
OAuth2
path Parameters
project_id
required
string

The ID of the project.

@@ -2603,7 +2603,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

List project access for a user

{schemes}://api.upsun.com/projects/{project_id}/user-access/{user_id}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

List project access for a user

Returns a list of items representing the user's project access.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2629,7 +2629,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Grant project access to a user

{schemes}://api.upsun.com/users/{user_id}/project-access

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Grant project access to a user

Adds the user to one or more specified projects.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2645,7 +2645,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Get project access for a user

{schemes}://api.upsun.com/users/{user_id}/project-access

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Get project access for a user

Retrieves the user's permissions for the current project.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2659,7 +2659,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "organization_id": "string",
  • "project_id": "string",
  • "project_title": "string",
  • "permissions": [
    ],
  • "granted_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update project access for a user

{schemes}://api.upsun.com/users/{user_id}/project-access/{project_id}

Response samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "organization_id": "string",
  • "project_id": "string",
  • "project_title": "string",
  • "permissions": [
    ],
  • "granted_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update project access for a user

Updates the user's permissions for the current project.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2677,7 +2677,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Remove project access for a user

{schemes}://api.upsun.com/users/{user_id}/project-access/{project_id}

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Remove project access for a user

Removes the user from the current project.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2693,7 +2693,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

API Tokens

List a user's API tokens

{schemes}://api.upsun.com/users/{user_id}/project-access/{project_id}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

API Tokens

List a user's API tokens

Retrieves a list of API tokens associated with a single user.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2703,7 +2703,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
[
  • {
    }
]

Create an API token

{schemes}://api.upsun.com/users/{user_id}/api-tokens

Response samples

Content type
application/json
[
  • {
    }
]

Create an API token

Creates an API token

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2719,7 +2719,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Conflict

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mfa_on_creation": true,
  • "token": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z"
}

Get an API token

{schemes}://api.upsun.com/users/{user_id}/api-tokens

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mfa_on_creation": true,
  • "token": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z"
}

Get an API token

Retrieves the specified API token.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2733,7 +2733,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mfa_on_creation": true,
  • "token": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z"
}

Delete an API token

{schemes}://api.upsun.com/users/{user_id}/api-tokens/{token_id}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mfa_on_creation": true,
  • "token": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z"
}

Delete an API token

Deletes an API token

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2747,7 +2747,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Connections

List federated login connections

{schemes}://api.upsun.com/users/{user_id}/api-tokens/{token_id}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Connections

List federated login connections

Retrieves a list of connections associated with a single user.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2757,7 +2757,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
[
  • {
    }
]

Get a federated login connection

{schemes}://api.upsun.com/users/{user_id}/connections

Response samples

Content type
application/json
[
  • {
    }
]

Get a federated login connection

Retrieves the specified connection.

Authorizations:
OAuth2
path Parameters
provider
required
string

The name of the federation provider.

@@ -2771,7 +2771,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "provider": "string",
  • "provider_type": "string",
  • "is_mandatory": true,
  • "subject": "string",
  • "email_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a federated login connection

{schemes}://api.upsun.com/users/{user_id}/connections/{provider}

Response samples

Content type
application/json
{
  • "provider": "string",
  • "provider_type": "string",
  • "is_mandatory": true,
  • "subject": "string",
  • "email_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a federated login connection

Deletes the specified connection.

Authorizations:
OAuth2
path Parameters
provider
required
string

The name of the federation provider.

@@ -2785,7 +2785,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

MFA

{schemes}://api.upsun.com/users/{user_id}/connections/{provider}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

MFA

Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Conflict

Response samples

Content type
application/json
{
  • "issuer": "http://example.com",
  • "account_name": "string",
  • "secret": "string",
  • "qr_code": "string"
}

Confirm TOTP enrollment

{schemes}://api.upsun.com/users/{user_id}/totp

Response samples

Content type
application/json
{
  • "issuer": "http://example.com",
  • "account_name": "string",
  • "secret": "string",
  • "qr_code": "string"
}

Confirm TOTP enrollment

Confirms the given TOTP enrollment.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2825,7 +2825,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Conflict

Request samples

Content type
application/json
{
  • "secret": "string",
  • "passcode": "string"
}

Response samples

Content type
application/json
{
  • "recovery_codes": [
    ]
}

Withdraw TOTP enrollment

{schemes}://api.upsun.com/users/{user_id}/totp

Request samples

Content type
application/json
{
  • "secret": "string",
  • "passcode": "string"
}

Response samples

Content type
application/json
{
  • "recovery_codes": [
    ]
}

Withdraw TOTP enrollment

Withdraws from the TOTP enrollment.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2837,7 +2837,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Re-create recovery codes

{schemes}://api.upsun.com/users/{user_id}/totp

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Re-create recovery codes

Re-creates recovery codes for the MFA enrollment.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2849,7 +2849,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "recovery_codes": [
    ]
}

Get organization MFA settings

{schemes}://api.upsun.com/users/{user_id}/codes

Response samples

Content type
application/json
{
  • "recovery_codes": [
    ]
}

Get organization MFA settings

Retrieves MFA settings for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "enforce_mfa": true
}

Enable organization MFA enforcement

{schemes}://api.upsun.com/organizations/{organization_id}/mfa-enforcement

Response samples

Content type
application/json
{
  • "enforce_mfa": true
}

Enable organization MFA enforcement

Enables MFA enforcement for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -2871,7 +2871,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Disable organization MFA enforcement

{schemes}://api.upsun.com/organizations/{organization_id}/mfa-enforcement/enable

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Disable organization MFA enforcement

Disables MFA enforcement for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -2881,7 +2881,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Send MFA reminders to organization members

{schemes}://api.upsun.com/organizations/{organization_id}/mfa-enforcement/disable

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Send MFA reminders to organization members

Sends a reminder about setting up MFA to the specified organization members.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -2895,25 +2895,25 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Request samples

Content type
application/json
{
  • "user_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Users

Get current logged-in user info Deprecated

{schemes}://api.upsun.com/organizations/{organization_id}/mfa/remind

Request samples

Content type
application/json
{
  • "user_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Users

Get current logged-in user info Deprecated

Retrieve information about the currently logged-in user (the user associated with the access token).

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "username": "string",
  • "display_name": "string",
  • "status": 0,
  • "mail": "user@example.com",
  • "ssh_keys": [
    ],
  • "has_key": true,
  • "projects": [
    ],
  • "sequence": 0,
  • "roles": [
    ],
  • "picture": "string",
  • "tickets": { },
  • "trial": true,
  • "current_trial": [
    ]
}

Check if phone verification is required

{schemes}://api.upsun.com/me

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "username": "string",
  • "display_name": "string",
  • "status": 0,
  • "mail": "user@example.com",
  • "ssh_keys": [
    ],
  • "has_key": true,
  • "projects": [
    ],
  • "sequence": 0,
  • "roles": [
    ],
  • "picture": "string",
  • "tickets": { },
  • "trial": true,
  • "current_trial": [
    ]
}

Check if phone verification is required

Find out if the current logged in user requires phone verification to create projects.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "verify_phone": true
}

Check if verification is required

{schemes}://api.upsun.com/me/phone

Response samples

Content type
application/json
{
  • "verify_phone": true
}

Check if verification is required

Find out if the current logged in user requires verification (phone or staff) to create projects.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "state": true,
  • "type": "string"
}

Get the current user

{schemes}://api.upsun.com/me/verification

Response samples

Content type
application/json
{
  • "state": true,
  • "type": "string"
}

Get the current user

Retrieves the current user, determined from the used access token.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deactivated": true,
  • "namespace": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "email_verified": true,
  • "first_name": "string",
  • "last_name": "string",
  • "picture": "http://example.com",
  • "company": "string",
  • "website": "http://example.com",
  • "country": "st",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "consented_at": "2019-08-24T14:15:22Z",
  • "consent_method": "opt-in"
}

Get a user by email

{schemes}://api.upsun.com/users/me

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deactivated": true,
  • "namespace": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "email_verified": true,
  • "first_name": "string",
  • "last_name": "string",
  • "picture": "http://example.com",
  • "company": "string",
  • "website": "http://example.com",
  • "country": "st",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "consented_at": "2019-08-24T14:15:22Z",
  • "consent_method": "opt-in"
}

Get a user by email

Retrieves a user matching the specified email address.

Authorizations:
OAuth2
path Parameters
email
required
string <email>
Example: hello@example.com

The user's email address.

@@ -2935,7 +2935,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deactivated": true,
  • "namespace": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "email_verified": true,
  • "first_name": "string",
  • "last_name": "string",
  • "picture": "http://example.com",
  • "company": "string",
  • "website": "http://example.com",
  • "country": "st",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "consented_at": "2019-08-24T14:15:22Z",
  • "consent_method": "opt-in"
}

Get a user by username

{schemes}://api.upsun.com/users/email={email}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deactivated": true,
  • "namespace": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "email_verified": true,
  • "first_name": "string",
  • "last_name": "string",
  • "picture": "http://example.com",
  • "company": "string",
  • "website": "http://example.com",
  • "country": "st",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "consented_at": "2019-08-24T14:15:22Z",
  • "consent_method": "opt-in"
}

Get a user by username

Retrieves a user matching the specified username.

Authorizations:
OAuth2
path Parameters
username
required
string
Example: platform-sh

The user's username.

@@ -2947,7 +2947,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
No sample

Get a user

{schemes}://api.upsun.com/users/username={username}

Response samples

Content type
application/json
No sample

Get a user

Retrieves the specified user.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2959,7 +2959,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deactivated": true,
  • "namespace": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "email_verified": true,
  • "first_name": "string",
  • "last_name": "string",
  • "picture": "http://example.com",
  • "company": "string",
  • "website": "http://example.com",
  • "country": "st",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "consented_at": "2019-08-24T14:15:22Z",
  • "consent_method": "opt-in"
}

Update a user

{schemes}://api.upsun.com/users/{user_id}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deactivated": true,
  • "namespace": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "email_verified": true,
  • "first_name": "string",
  • "last_name": "string",
  • "picture": "http://example.com",
  • "company": "string",
  • "website": "http://example.com",
  • "country": "st",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "consented_at": "2019-08-24T14:15:22Z",
  • "consent_method": "opt-in"
}

Update a user

Updates the specified user.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2985,7 +2985,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deactivated": true,
  • "namespace": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "email_verified": true,
  • "first_name": "string",
  • "last_name": "string",
  • "picture": "http://example.com",
  • "company": "string",
  • "website": "http://example.com",
  • "country": "st",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "consented_at": "2019-08-24T14:15:22Z",
  • "consent_method": "opt-in"
}

Reset email address

{schemes}://api.upsun.com/users/{user_id}

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "deactivated": true,
  • "namespace": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "email_verified": true,
  • "first_name": "string",
  • "last_name": "string",
  • "picture": "http://example.com",
  • "company": "string",
  • "website": "http://example.com",
  • "country": "st",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "consented_at": "2019-08-24T14:15:22Z",
  • "consent_method": "opt-in"
}

Reset email address

Requests a reset of the user's email address. A confirmation email will be sent to the new address when the request is accepted.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -2999,7 +2999,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Conflict

Request samples

Content type
application/json
{
  • "email_address": "user@example.com"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Reset user password

{schemes}://api.upsun.com/users/{user_id}/emailaddress

Request samples

Content type
application/json
{
  • "email_address": "user@example.com"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Reset user password

Requests a reset of the user's password. A password reset email will be sent to the user when the request is accepted.

Authorizations:
OAuth2
path Parameters
user_id
required
string <uuid>
Example: d81c8ee2-44b3-429f-b944-a33ad7437690

The ID of the user.

@@ -3009,17 +3009,17 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

User Profiles

List user profiles

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

User Profiles

List user profiles

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "profiles": [
    ],
  • "_links": {
    }
}

Get a single user profile

Authorizations:
OAuth2
path Parameters
userId
required
string
{schemes}://api.upsun.com/profiles

Response samples

Content type
application/json
{
  • "count": 0,
  • "profiles": [
    ],
  • "_links": {
    }
}

Get a single user profile

Authorizations:
OAuth2
path Parameters
userId
required
string

The UUID of the user

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "display_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "type": "user",
  • "picture": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "currency": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "website_url": "string",
  • "new_ui": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "marketing": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_contact": "user@example.com",
  • "security_contact": "user@example.com",
  • "current_trial": {
    },
  • "invoiced": true
}

Update a user profile

{schemes}://api.upsun.com/profiles/{userId}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "display_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "type": "user",
  • "picture": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "currency": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "website_url": "string",
  • "new_ui": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "marketing": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_contact": "user@example.com",
  • "security_contact": "user@example.com",
  • "current_trial": {
    },
  • "invoiced": true
}

Update a user profile

Update a user profile, supplying one or more key/value pairs to to change.

Authorizations:
OAuth2
path Parameters
userId
required
string

The UUID of the user

@@ -3053,13 +3053,13 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

A User profile object

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "username": "string",
  • "current_password": "string",
  • "password": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "marketing": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "picture": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "display_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "type": "user",
  • "picture": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "currency": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "website_url": "string",
  • "new_ui": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "marketing": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_contact": "user@example.com",
  • "security_contact": "user@example.com",
  • "current_trial": {
    },
  • "invoiced": true
}

Get a user address

Authorizations:
OAuth2
path Parameters
userId
required
string
{schemes}://api.upsun.com/profiles/{userId}

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "username": "string",
  • "current_password": "string",
  • "password": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "marketing": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "picture": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "display_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "type": "user",
  • "picture": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "currency": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "website_url": "string",
  • "new_ui": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "marketing": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_contact": "user@example.com",
  • "security_contact": "user@example.com",
  • "current_trial": {
    },
  • "invoiced": true
}

Get a user address

Authorizations:
OAuth2
path Parameters
userId
required
string

The UUID of the user

Responses

Response samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string",
  • "metadata": {
    }
}

Update a user address

{schemes}://api.upsun.com/profiles/{userId}/address

Response samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string",
  • "metadata": {
    }
}

Update a user address

Update a user address, supplying one or more key/value pairs to to change.

Authorizations:
OAuth2
path Parameters
userId
required
string

The UUID of the user

@@ -3087,7 +3087,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

A user Address object extended with field metadata.

Request samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string"
}

Response samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string",
  • "metadata": {
    }
}

Create a user profile picture

Authorizations:
OAuth2
path Parameters
uuid
required
string <uuid>
{schemes}://api.upsun.com/profiles/{userId}/address

Request samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string"
}

Response samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string",
  • "metadata": {
    }
}

Create a user profile picture

Authorizations:
OAuth2
path Parameters
uuid
required
string <uuid>

The uuid of the user

Request Body schema: multipart/form-data
required
file
string <binary>

The image file to upload.

@@ -3095,7 +3095,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

The new picture url.

Response samples

Content type
application/json
{
  • "url": "string"
}

Delete a user profile picture

Authorizations:
OAuth2
path Parameters
uuid
required
string <uuid>
{schemes}://api.upsun.com/profile/{uuid}/picture

Response samples

Content type
application/json
{
  • "url": "string"
}

Delete a user profile picture

Authorizations:
OAuth2
path Parameters
uuid
required
string <uuid>

The uuid of the user

Responses

Response samples

Content type
application/json
{
  • "key_id": 0,
  • "uid": 0,
  • "fingerprint": "string",
  • "title": "string",
  • "value": "string",
  • "changed": "string"
}

Delete an SSH key

Authorizations:
OAuth2
path Parameters
key_id
required
integer
{schemes}://api.upsun.com/ssh_keys/{key_id}

Response samples

Content type
application/json
{
  • "key_id": 0,
  • "uid": 0,
  • "fingerprint": "string",
  • "title": "string",
  • "value": "string",
  • "changed": "string"
}

Delete an SSH key

Authorizations:
OAuth2
path Parameters
key_id
required
integer

The ID of the ssh key.

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "title": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "key_id": 0,
  • "uid": 0,
  • "fingerprint": "string",
  • "title": "string",
  • "value": "string",
  • "changed": "string"
}

Plans

List available plans

Retrieve information about plans and pricing on Platform.sh.

-
Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "plans": [
    ],
  • "_links": {
    }
}

Organization Management

Estimate total spend

{schemes}://api.upsun.com/ssh_keys

Request samples

Content type
application/json
{
  • "value": "string",
  • "title": "string",
  • "uuid": "string"
}

Response samples

Content type
application/json
{
  • "key_id": 0,
  • "uid": 0,
  • "fingerprint": "string",
  • "title": "string",
  • "value": "string",
  • "changed": "string"
}

Organization Management

Estimate total spend

Estimates the total spend for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "total": "string",
  • "sub_total": "string",
  • "vouchers": "string",
  • "user_licenses": {
    },
  • "user_management": "string",
  • "support_level": "string",
  • "subscriptions": {
    }
}

Get billing alert configuration

{schemes}://api.upsun.com/organizations/{organization_id}/estimate

Response samples

Content type
application/json
{
  • "total": "string",
  • "sub_total": "string",
  • "vouchers": "string",
  • "user_licenses": {
    },
  • "user_management": "string",
  • "support_level": "string",
  • "subscriptions": {
    }
}

Get billing alert configuration

Retrieves billing alert configuration for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "string",
  • "active": true,
  • "alerts_sent": 0,
  • "last_alert_at": "string",
  • "updated_at": "string",
  • "config": {
    }
}

Update billing alert configuration

{schemes}://api.upsun.com/organizations/{organization_id}/alerts/billing

Response samples

Content type
application/json
{
  • "id": "string",
  • "active": true,
  • "alerts_sent": 0,
  • "last_alert_at": "string",
  • "updated_at": "string",
  • "config": {
    }
}

Update billing alert configuration

Updates billing alert configuration for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "active": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "active": true,
  • "alerts_sent": 0,
  • "last_alert_at": "string",
  • "updated_at": "string",
  • "config": {
    }
}

Get organization prepayment information

{schemes}://api.upsun.com/organizations/{organization_id}/alerts/billing

Request samples

Content type
application/json
{
  • "active": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "active": true,
  • "alerts_sent": 0,
  • "last_alert_at": "string",
  • "updated_at": "string",
  • "config": {
    }
}

Get organization prepayment information

Retrieves prepayment information for the specified organization, if applicable.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3187,7 +3181,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "prepayment": {
    },
  • "_links": {
    }
}

List organization prepayment transactions

{schemes}://api.upsun.com/organizations/{organization_id}/prepayment

Response samples

Content type
application/json
{
  • "prepayment": {
    },
  • "_links": {
    }
}

List organization prepayment transactions

Retrieves a list of prepayment transactions for the specified organization, if applicable.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3199,7 +3193,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "count": 0,
  • "transactions": [
    ],
  • "_links": {
    }
}

Subscriptions

{schemes}://api.upsun.com/organizations/{organization_id}/prepayment/transactions

Response samples

Content type
application/json
{
  • "count": 0,
  • "transactions": [
    ],
  • "_links": {
    }
}

Subscriptions

Each project is represented by a subscription that holds the plan information. @@ -3219,7 +3213,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Check result with error message if presented

Response samples

Content type
application/json
{
  • "can_update": true,
  • "message": "string",
  • "required_action": { }
}

Estimate the price of a new subscription

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/subscriptions/{subscriptionId}/can-update

Response samples

Content type
application/json
{
  • "can_update": true,
  • "message": "string",
  • "required_action": { }
}

Estimate the price of a new subscription

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

query Parameters
plan
required
string

The plan type of the subscription.

@@ -3239,7 +3233,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "plan": "string",
  • "user_licenses": "string",
  • "environments": "string",
  • "storage": "string",
  • "total": "string",
  • "options": { }
}

Checks if the user is able to create a new project.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/estimate

Response samples

Content type
application/json
{
  • "plan": "string",
  • "user_licenses": "string",
  • "environments": "string",
  • "storage": "string",
  • "total": "string",
  • "options": { }
}

Checks if the user is able to create a new project.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

Responses

Response samples

Content type
application/json
{
  • "can_create": true,
  • "message": "string",
  • "required_action": {
    }
}

Estimate the price of a subscription

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/can-create

Response samples

Content type
application/json
{
  • "can_create": true,
  • "message": "string",
  • "required_action": {
    }
}

Estimate the price of a subscription

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -3269,7 +3263,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "plan": "string",
  • "user_licenses": "string",
  • "environments": "string",
  • "storage": "string",
  • "total": "string",
  • "options": { }
}

Get current usage for a subscription

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/estimate

Response samples

Content type
application/json
{
  • "plan": "string",
  • "user_licenses": "string",
  • "environments": "string",
  • "storage": "string",
  • "total": "string",
  • "options": { }
}

Get current usage for a subscription

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -3283,7 +3277,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "cpu_app": {
    },
  • "storage_app_services": {
    },
  • "memory_app": {
    },
  • "cpu_services": {
    },
  • "memory_services": {
    },
  • "backup_storage": {
    },
  • "build_cpu": {
    },
  • "build_memory": {
    },
  • "egress_bandwidth": {
    },
  • "ingress_requests": {
    },
  • "logs_fwd_content_size": {
    },
  • "fastly_bandwidth": {
    },
  • "fastly_requests": {
    }
}

List addons for a subscription

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/current_usage

Response samples

Content type
application/json
{
  • "cpu_app": {
    },
  • "storage_app_services": {
    },
  • "memory_app": {
    },
  • "cpu_services": {
    },
  • "memory_services": {
    },
  • "backup_storage": {
    },
  • "build_cpu": {
    },
  • "build_memory": {
    },
  • "egress_bandwidth": {
    },
  • "ingress_requests": {
    },
  • "logs_fwd_content_size": {
    },
  • "fastly_bandwidth": {
    },
  • "fastly_requests": {
    }
}

List addons for a subscription

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -3293,7 +3287,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "available": {
    },
  • "current": {
    },
  • "upgrades_available": {
    }
}

Get usage alerts

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/addons

Response samples

Content type
application/json
{
  • "available": {
    },
  • "current": {
    },
  • "upgrades_available": {
    }
}

Get usage alerts

Retrieves current and available usage alerts.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "available": [
    ]
}

Update usage alerts.

{schemes}://api.upsun.com/organizations/{organization_id}/alerts/subscriptions/{subscription_id}/usage

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "available": [
    ]
}

Update usage alerts.

Updates usage alerts for a subscription.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "alerts": [
    ]
}

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "available": [
    ]
}

List subscriptions

{schemes}://api.upsun.com/organizations/{organization_id}/alerts/subscriptions/{subscription_id}/usage

Request samples

Content type
application/json
{
  • "alerts": [
    ]
}

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "available": [
    ]
}

List subscriptions

Retrieves subscriptions for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3363,7 +3357,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Create subscription

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Create subscription

Creates a subscription for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3391,7 +3385,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "plan": "string",
  • "project_region": "string",
  • "project_title": "string",
  • "options_url": "string",
  • "default_branch": "string",
  • "environments": 0,
  • "storage": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "requested",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "owner_info": {
    },
  • "vendor": "string",
  • "plan": "string",
  • "environments": 0,
  • "storage": 0,
  • "user_licenses": 0,
  • "project_id": "string",
  • "project_endpoint": "string",
  • "project_title": "string",
  • "project_region": "string",
  • "project_region_label": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "agency_site": true,
  • "invoiced": true,
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "green": true
}

Get subscription

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions

Request samples

Content type
application/json
{
  • "plan": "string",
  • "project_region": "string",
  • "project_title": "string",
  • "options_url": "string",
  • "default_branch": "string",
  • "environments": 0,
  • "storage": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "requested",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "owner_info": {
    },
  • "vendor": "string",
  • "plan": "string",
  • "environments": 0,
  • "storage": 0,
  • "user_licenses": 0,
  • "project_id": "string",
  • "project_endpoint": "string",
  • "project_title": "string",
  • "project_region": "string",
  • "project_region_label": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "agency_site": true,
  • "invoiced": true,
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "green": true
}

Get subscription

Retrieves a subscription for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3405,7 +3399,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "requested",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "owner_info": {
    },
  • "vendor": "string",
  • "plan": "string",
  • "environments": 0,
  • "storage": 0,
  • "user_licenses": 0,
  • "project_id": "string",
  • "project_endpoint": "string",
  • "project_title": "string",
  • "project_region": "string",
  • "project_region_label": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "agency_site": true,
  • "invoiced": true,
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "green": true
}

Update subscription

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "requested",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "owner_info": {
    },
  • "vendor": "string",
  • "plan": "string",
  • "environments": 0,
  • "storage": 0,
  • "user_licenses": 0,
  • "project_id": "string",
  • "project_endpoint": "string",
  • "project_title": "string",
  • "project_region": "string",
  • "project_region_label": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "agency_site": true,
  • "invoiced": true,
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "green": true
}

Update subscription

Updates a subscription for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3445,7 +3439,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "project_title": "string",
  • "plan": "string",
  • "timezone": "string",
  • "environments": 0,
  • "storage": 0,
  • "big_dev": "string",
  • "big_dev_service": "string",
  • "backups": "string",
  • "observability_suite": "string",
  • "blackfire": "string",
  • "continuous_profiling": "string",
  • "project_support_level": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "requested",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "owner_info": {
    },
  • "vendor": "string",
  • "plan": "string",
  • "environments": 0,
  • "storage": 0,
  • "user_licenses": 0,
  • "project_id": "string",
  • "project_endpoint": "string",
  • "project_title": "string",
  • "project_region": "string",
  • "project_region_label": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "agency_site": true,
  • "invoiced": true,
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "green": true
}

Delete subscription

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}

Request samples

Content type
application/json
{
  • "project_title": "string",
  • "plan": "string",
  • "timezone": "string",
  • "environments": 0,
  • "storage": 0,
  • "big_dev": "string",
  • "big_dev_service": "string",
  • "backups": "string",
  • "observability_suite": "string",
  • "blackfire": "string",
  • "continuous_profiling": "string",
  • "project_support_level": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "requested",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "owner_info": {
    },
  • "vendor": "string",
  • "plan": "string",
  • "environments": 0,
  • "storage": 0,
  • "user_licenses": 0,
  • "project_id": "string",
  • "project_endpoint": "string",
  • "project_title": "string",
  • "project_region": "string",
  • "project_region_label": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "agency_site": true,
  • "invoiced": true,
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "green": true
}

Delete subscription

Deletes a subscription for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3459,7 +3453,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Orders

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Orders

These endpoints can be used to retrieve order information from our billing @@ -3493,7 +3487,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Get order

{schemes}://api.upsun.com/organizations/{organization_id}/orders

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Get order

Retrieves an order for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "completed",
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "address": {
    },
  • "company": "string",
  • "vat_number": "string",
  • "billing_period_start": "2019-08-24T14:15:22Z",
  • "billing_period_end": "2019-08-24T14:15:22Z",
  • "billing_period_label": {
    },
  • "billing_period_duration": 0,
  • "paid_on": "2019-08-24T14:15:22Z",
  • "total": 0,
  • "total_formatted": 0,
  • "components": {
    },
  • "currency": "string",
  • "invoice_url": "string",
  • "last_refreshed": "2019-08-24T14:15:22Z",
  • "invoiced": true,
  • "line_items": [
    ],
  • "_links": {
    }
}

Create confirmation credentials for for 3D-Secure

{schemes}://api.upsun.com/organizations/{organization_id}/orders/{order_id}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "completed",
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  • "address": {
    },
  • "company": "string",
  • "vat_number": "string",
  • "billing_period_start": "2019-08-24T14:15:22Z",
  • "billing_period_end": "2019-08-24T14:15:22Z",
  • "billing_period_label": {
    },
  • "billing_period_duration": 0,
  • "paid_on": "2019-08-24T14:15:22Z",
  • "total": 0,
  • "total_formatted": 0,
  • "components": {
    },
  • "currency": "string",
  • "invoice_url": "string",
  • "last_refreshed": "2019-08-24T14:15:22Z",
  • "invoiced": true,
  • "line_items": [
    ],
  • "_links": {
    }
}

Create confirmation credentials for for 3D-Secure

Creates confirmation credentials for payments that require online authorization

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "redirect_to_url": {
    },
  • "type": "string"
}

Invoices

{schemes}://api.upsun.com/organizations/{organization_id}/orders/{order_id}/authorize

Response samples

Content type
application/json
{
  • "redirect_to_url": {
    },
  • "type": "string"
}

Invoices

These endpoints can be used to retrieve invoices from our billing system. @@ -3557,7 +3551,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get invoice

{schemes}://api.upsun.com/organizations/{organization_id}/invoices

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get invoice

Retrieves an invoice for the specified organization.

Authorizations:
OAuth2
path Parameters
invoice_id
required
string

The ID of the invoice.

@@ -3573,17 +3567,17 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "string",
  • "invoice_number": "string",
  • "type": "invoice",
  • "order_id": "string",
  • "related_invoice_id": "string",
  • "status": "paid",
  • "owner": "string",
  • "invoice_date": "2019-08-24T14:15:22Z",
  • "invoice_due": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "changed": "2019-08-24T14:15:22Z",
  • "company": "string",
  • "total": 0.1,
  • "address": {
    },
  • "notes": "string",
  • "invoice_pdf": {
    }
}

Discounts

Get an organization discount

Authorizations:
OAuth2
path Parameters
id
required
string
{schemes}://api.upsun.com/organizations/{organization_id}/invoices/{invoice_id}

Response samples

Content type
application/json
{
  • "id": "string",
  • "invoice_number": "string",
  • "type": "invoice",
  • "order_id": "string",
  • "related_invoice_id": "string",
  • "status": "paid",
  • "owner": "string",
  • "invoice_date": "2019-08-24T14:15:22Z",
  • "invoice_due": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "changed": "2019-08-24T14:15:22Z",
  • "company": "string",
  • "total": 0.1,
  • "address": {
    },
  • "notes": "string",
  • "invoice_pdf": {
    }
}

Discounts

Get an organization discount

Authorizations:
OAuth2
path Parameters
id
required
string

The ID of the organization discount

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "organization_id": "string",
  • "type": "allowance",
  • "type_label": "string",
  • "status": "inactive",
  • "commitment": {
    },
  • "total_months": 0,
  • "discount": {
    },
  • "config": { },
  • "start_at": "2019-08-24T14:15:22Z",
  • "end_at": "2019-08-24T14:15:22Z"
}

Get the value of the First Project Incentive discount

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "organization_id": "string",
  • "type": "allowance",
  • "type_label": "string",
  • "status": "inactive",
  • "commitment": {
    },
  • "total_months": 0,
  • "discount": {
    },
  • "config": { },
  • "start_at": "2019-08-24T14:15:22Z",
  • "end_at": "2019-08-24T14:15:22Z"
}

Get the value of the First Project Incentive discount

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "currencies": {
    }
}

List organization discounts

{schemes}://api.upsun.com/discounts/types/allowance

Response samples

Content type
application/json
{
  • "currencies": {
    }
}

List organization discounts

Retrieves all applicable discounts granted to the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Vouchers

{schemes}://api.upsun.com/organizations/{organization_id}/discounts

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Vouchers

These endpoints can be used to retrieve vouchers associated with a particular user as well as apply a voucher to a particular user.

@@ -3615,7 +3609,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "vouchers_total": "string",
  • "vouchers_applied": "string",
  • "vouchers_remaining_balance": "string",
  • "currency": "string",
  • "vouchers": [
    ],
  • "_links": {
    }
}

Apply voucher

{schemes}://api.upsun.com/organizations/{organization_id}/vouchers

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "vouchers_total": "string",
  • "vouchers_applied": "string",
  • "vouchers_remaining_balance": "string",
  • "currency": "string",
  • "vouchers": [
    ],
  • "_links": {
    }
}

Apply voucher

Applies a voucher for the specified organization, and refreshes the currently open order.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3629,7 +3623,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Records

{schemes}://api.upsun.com/organizations/{organization_id}/vouchers/apply

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/problem+json
{
  • "status": "string",
  • "message": "string",
  • "code": 0,
  • "detail": { },
  • "title": "string"
}

Records

These endpoints retrieve information about which plans were assigned to a particular project at which time.

@@ -3663,7 +3657,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

List usage records

{schemes}://api.upsun.com/organizations/{organization_id}/records/plan

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

List usage records

Retrieves usage records for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Profiles

Get address

{schemes}://api.upsun.com/organizations/{organization_id}/records/usage

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": {
    }
}

Profiles

Get address

Retrieves the address for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string"
}

Update address

{schemes}://api.upsun.com/organizations/{organization_id}/address

Response samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string"
}

Update address

Updates the address for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3735,7 +3729,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string"
}

Response samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string"
}

Get profile

{schemes}://api.upsun.com/organizations/{organization_id}/address

Request samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string"
}

Response samples

Content type
application/json
{
  • "country": "string",
  • "name_line": "string",
  • "premise": "string",
  • "sub_premise": "string",
  • "thoroughfare": "string",
  • "administrative_area": "string",
  • "sub_administrative_area": "string",
  • "locality": "string",
  • "dependent_locality": "string",
  • "postal_code": "string"
}

Get profile

Retrieves the profile for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string
Using the Access Token " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "display_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "type": "user",
  • "picture": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "currency": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "website_url": "string",
  • "new_ui": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "marketing": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_contact": "user@example.com",
  • "security_contact": "user@example.com",
  • "current_trial": {
    },
  • "invoiced": true
}

Update profile

{schemes}://api.upsun.com/organizations/{organization_id}/profile

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "display_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "type": "user",
  • "picture": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "currency": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "website_url": "string",
  • "new_ui": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "marketing": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_contact": "user@example.com",
  • "security_contact": "user@example.com",
  • "current_trial": {
    },
  • "invoiced": true
}

Update profile

Updates the profile for the specified organization.

Authorizations:
OAuth2
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3775,7 +3769,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Request samples

Content type
application/json
{
  • "default_catalog": "string",
  • "project_options_url": "http://example.com",
  • "security_contact": "user@example.com",
  • "company_name": "string",
  • "vat_number": "string",
  • "billing_contact": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "display_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "type": "user",
  • "picture": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "currency": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "website_url": "string",
  • "new_ui": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "marketing": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_contact": "user@example.com",
  • "security_contact": "user@example.com",
  • "current_trial": {
    },
  • "invoiced": true
}

References

List referenced users

{schemes}://api.upsun.com/organizations/{organization_id}/profile

Request samples

Content type
application/json
{
  • "default_catalog": "string",
  • "project_options_url": "http://example.com",
  • "security_contact": "user@example.com",
  • "company_name": "string",
  • "vat_number": "string",
  • "billing_contact": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "display_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "type": "user",
  • "picture": "string",
  • "company_type": "string",
  • "company_name": "string",
  • "currency": "string",
  • "vat_number": "string",
  • "company_role": "string",
  • "website_url": "string",
  • "new_ui": true,
  • "ui_colorscheme": "string",
  • "default_catalog": "string",
  • "project_options_url": "string",
  • "marketing": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_contact": "user@example.com",
  • "security_contact": "user@example.com",
  • "current_trial": {
    },
  • "invoiced": true
}

References

List referenced users

Retrieves a list of users referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:users:0.

Authorizations:
OAuth2
query Parameters
in
required
string

The list of comma-separated user IDs generated by a trusted service.

@@ -3787,7 +3781,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Bad Request

Response samples

Content type
application/json
{}

List referenced teams

{schemes}://api.upsun.com/ref/users

Response samples

Content type
application/json
{}

List referenced teams

Retrieves a list of teams referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:teams:0.

Authorizations:
OAuth2
query Parameters
in
required
string

The list of comma-separated team IDs generated by a trusted service.

@@ -3799,7 +3793,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Bad Request

Response samples

Content type
application/json
{
  • "01FVMKN9KHVWWVY488AVKDWHR3": {
    }
}

List referenced organizations

{schemes}://api.upsun.com/ref/teams

Response samples

Content type
application/json
{
  • "01FVMKN9KHVWWVY488AVKDWHR3": {
    }
}

List referenced organizations

Retrieves a list of organizations referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:organizations:0.

Authorizations:
OAuth2
query Parameters
in
required
string

The list of comma-separated organization IDs generated by a trusted service.

@@ -3813,7 +3807,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Forbidden

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

List referenced projects

{schemes}://api.upsun.com/ref/organizations

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

List referenced projects

Retrieves a list of projects referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:projects:0.

Authorizations:
OAuth2
query Parameters
in
required
string

The list of comma-separated project IDs generated by a trusted service.

@@ -3829,7 +3823,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

List referenced regions

{schemes}://api.upsun.com/ref/projects

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

List referenced regions

Retrieves a list of regions referenced by a trusted service. Clients cannot construct the URL themselves. The correct URL will be provided in the HAL links of another API response, in the _links object with a key like ref:regions:0.

Authorizations:
OAuth2
query Parameters
in
required
string

The list of comma-separated region IDs generated by a trusted service.

@@ -3845,7 +3839,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Regions

List regions

{schemes}://api.upsun.com/ref/regions

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Regions

List regions

Retrieves a list of available regions.

Authorizations:
OAuth2
query Parameters
object (StringFilter)

Allows filtering by available using one or more operators.

@@ -3875,7 +3869,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "regions": [
    ],
  • "_links": {
    }
}

Get region

{schemes}://api.upsun.com/regions

Response samples

Content type
application/json
{
  • "regions": [
    ],
  • "_links": {
    }
}

Get region

Retrieves the specified region.

Authorizations:
OAuth2
path Parameters
region_id
required
string

The ID of the region.

@@ -3887,7 +3881,7 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw eRTzUs ljKHqG">

Not Found

Response samples

Content type
application/json
{
  • "id": "string",
  • "label": "string",
  • "zone": "string",
  • "selection_label": "string",
  • "project_label": "string",
  • "timezone": "string",
  • "available": true,
  • "private": true,
  • "endpoint": "string",
  • "provider": {
    },
  • "datacenter": {
    },
  • "environmental_impact": {
    }
}

Project Settings

{schemes}://api.upsun.com/regions/{region_id}

Response samples

Content type
application/json
{
  • "id": "string",
  • "label": "string",
  • "zone": "string",
  • "selection_label": "string",
  • "project_label": "string",
  • "timezone": "string",
  • "available": true,
  • "private": true,
  • "endpoint": "string",
  • "provider": {
    },
  • "datacenter": {
    },
  • "environmental_impact": {
    }
}

Project Settings

Using the Access Token " class="sc-eVqvcJ sc-fszimp kIppRw fOdxau">

Retrieve the global settings for a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "initialize": { },
  • "product_name": "string",
  • "product_code": "string",
  • "ui_uri_template": "string",
  • "variables_prefix": "string",
  • "bot_email": "string",
  • "application_config_file": "string",
  • "project_config_dir": "string",
  • "use_drupal_defaults": true,
  • "use_legacy_subdomains": true,
  • "development_service_size": "2XL",
  • "development_application_size": "2XL",
  • "enable_certificate_provisioning": true,
  • "certificate_style": "ecdsa",
  • "certificate_renewal_activity": true,
  • "development_domain_template": "string",
  • "enable_state_api_deployments": true,
  • "temporary_disk_size": 0,
  • "local_disk_size": 0,
  • "cron_minimum_interval": 0,
  • "cron_maximum_jitter": 0,
  • "cron_production_expiry_interval": 0,
  • "cron_non_production_expiry_interval": 0,
  • "concurrency_limits": {
    },
  • "flexible_build_cache": true,
  • "strict_configuration": true,
  • "has_sleepy_crons": true,
  • "crons_in_git": true,
  • "custom_error_template": "string",
  • "app_error_page_template": "string",
  • "environment_name_strategy": "hash",
  • "data_retention": {
    },
  • "enable_codesource_integration_push": true,
  • "enforce_mfa": true,
  • "systemd": true,
  • "router_gen2": true,
  • "build_resources": {
    },
  • "outbound_restrictions_default_policy": "allow",
  • "self_upgrade": true,
  • "additional_hosts": {
    },
  • "max_allowed_routes": 0,
  • "max_allowed_redirects_paths": 0,
  • "enable_incremental_backups": true,
  • "sizing_api_enabled": true,
  • "enable_cache_grace_period": true,
  • "enable_zero_downtime_deployments": true,
  • "enable_admin_agent": true,
  • "certifier_url": "string",
  • "centralized_permissions": true,
  • "glue_server_max_request_size": 0,
  • "persistent_endpoints_ssh": true,
  • "persistent_endpoints_ssl_certificates": true,
  • "enable_disk_health_monitoring": true,
  • "enable_paused_environments": true,
  • "enable_unified_configuration": true,
  • "enable_routes_tracing": true,
  • "image_deployment_validation": true,
  • "support_generic_images": true,
  • "enable_github_app_token_exchange": true,
  • "continuous_profiling": {
    },
  • "disable_agent_error_reporter": true,
  • "requires_domain_ownership": true,
  • "enable_guaranteed_resources": true,
  • "git_server": {
    },
  • "activity_logs_max_size": 0,
  • "allow_manual_deployments": true,
  • "allow_rolling_deployments": true,
  • "allow_burst": true,
  • "router_resources": {
    }
}

Update a project setting

{schemes}://api.upsun.com/projects/{projectId}/settings

Response samples

Content type
application/json
{
  • "initialize": { },
  • "product_name": "string",
  • "product_code": "string",
  • "ui_uri_template": "string",
  • "variables_prefix": "string",
  • "bot_email": "string",
  • "application_config_file": "string",
  • "project_config_dir": "string",
  • "use_drupal_defaults": true,
  • "use_legacy_subdomains": true,
  • "development_service_size": "2XL",
  • "development_application_size": "2XL",
  • "enable_certificate_provisioning": true,
  • "certificate_style": "ecdsa",
  • "certificate_renewal_activity": true,
  • "development_domain_template": "string",
  • "enable_state_api_deployments": true,
  • "temporary_disk_size": 0,
  • "local_disk_size": 0,
  • "cron_minimum_interval": 0,
  • "cron_maximum_jitter": 0,
  • "cron_production_expiry_interval": 0,
  • "cron_non_production_expiry_interval": 0,
  • "concurrency_limits": {
    },
  • "flexible_build_cache": true,
  • "strict_configuration": true,
  • "has_sleepy_crons": true,
  • "crons_in_git": true,
  • "custom_error_template": "string",
  • "app_error_page_template": "string",
  • "environment_name_strategy": "hash",
  • "data_retention": {
    },
  • "enable_codesource_integration_push": true,
  • "enforce_mfa": true,
  • "systemd": true,
  • "router_gen2": true,
  • "build_resources": {
    },
  • "outbound_restrictions_default_policy": "allow",
  • "self_upgrade": true,
  • "self_upgrade_latest_major": true,
  • "additional_hosts": {
    },
  • "max_allowed_routes": 0,
  • "max_allowed_redirects_paths": 0,
  • "enable_incremental_backups": true,
  • "sizing_api_enabled": true,
  • "enable_cache_grace_period": true,
  • "enable_zero_downtime_deployments": true,
  • "enable_admin_agent": true,
  • "certifier_url": "string",
  • "centralized_permissions": true,
  • "glue_server_max_request_size": 0,
  • "persistent_endpoints_ssh": true,
  • "persistent_endpoints_ssl_certificates": true,
  • "enable_disk_health_monitoring": true,
  • "enable_paused_environments": true,
  • "enable_unified_configuration": true,
  • "enable_routes_tracing": true,
  • "image_deployment_validation": true,
  • "support_generic_images": true,
  • "enable_github_app_token_exchange": true,
  • "continuous_profiling": {
    },
  • "disable_agent_error_reporter": true,
  • "requires_domain_ownership": true,
  • "enable_guaranteed_resources": true,
  • "git_server": {
    },
  • "activity_logs_max_size": 0,
  • "allow_manual_deployments": true,
  • "allow_rolling_deployments": true,
  • "allow_burst": true,
  • "router_resources": {
    }
}

Update a project setting

Update one or more project-level settings.

Authorizations:
OAuth2
path Parameters
projectId
required
string
Request Body schema: application/json
required
initialize
object (Initialization key)
object or null (Data retention configuration)
object (Build Resources)

Responses

Request samples

Content type
application/json
{
  • "initialize": { },
  • "data_retention": {
    },
  • "build_resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Deployment Target

{schemes}://api.upsun.com/projects/{projectId}/settings

Request samples

Content type
application/json
{
  • "initialize": { },
  • "data_retention": {
    },
  • "build_resources": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Deployment Target

Using the Access Token " class="sc-eVqvcJ sc-fszimp kIppRw fOdxau">

The deployment target information for the project.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a project deployment target

{schemes}://api.upsun.com/projects/{projectId}/deployments

Response samples

Content type
application/json
[
  • {
    }
]

Create a project deployment target

Set the deployment target information for a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
Request Body schema: application/json
required
One of
type
required
string (The type of the deployment target.)
Enum: "dedicated" "enterprise" "local"
name
required
string (The name of the deployment target.)
enforced_mounts
object (Mounts which are always injected into pushed (e.g. enforce /var/log to be a local mount).)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "dedicated",
  • "name": "string",
  • "enforced_mounts": { }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a single project deployment target

{schemes}://api.upsun.com/projects/{projectId}/deployments

Request samples

Content type
application/json
Example
{
  • "type": "dedicated",
  • "name": "string",
  • "enforced_mounts": { }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Get a single project deployment target

Get a single deployment target configuration of a project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
deploymentTargetConfigurationId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "type": "dedicated",
  • "name": "string",
  • "deploy_host": "string",
  • "deploy_port": 0,
  • "ssh_host": "string",
  • "hosts": [
    ],
  • "auto_mounts": true,
  • "excluded_mounts": [
    ],
  • "enforced_mounts": { },
  • "auto_crons": true,
  • "auto_nginx": true,
  • "maintenance_mode": true,
  • "guardrails_phase": 0
}

Update a project deployment

Authorizations:
OAuth2
path Parameters
projectId
required
string
deploymentTargetConfigurationId
required
string
Request Body schema: application/json
required
One of
type
required
string (The type of the deployment target.)
Enum: "dedicated" "enterprise" "local"
name
required
string (The name of the deployment target.)
enforced_mounts
object (Mounts which are always injected into pushed (e.g. enforce /var/log to be a local mount).)

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "type": "dedicated",
  • "name": "string",
  • "deploy_host": "string",
  • "deploy_port": 0,
  • "ssh_host": "string",
  • "hosts": [
    ],
  • "auto_mounts": true,
  • "excluded_mounts": [
    ],
  • "enforced_mounts": { },
  • "auto_crons": true,
  • "auto_nginx": true,
  • "maintenance_mode": true,
  • "guardrails_phase": 0
}

Update a project deployment

Authorizations:
OAuth2
path Parameters
projectId
required
string
deploymentTargetConfigurationId
required
string
Request Body schema: application/json
required
One of
type
required
string (The type of the deployment target.)
Enum: "dedicated" "enterprise" "local"
name
required
string (The name of the deployment target.)
enforced_mounts
object (Mounts which are always injected into pushed (e.g. enforce /var/log to be a local mount).)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "dedicated",
  • "name": "string",
  • "enforced_mounts": { }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete a single project deployment target

{schemes}://api.upsun.com/projects/{projectId}/deployments/{deploymentTargetConfigurationId}

Request samples

Content type
application/json
Example
{
  • "type": "dedicated",
  • "name": "string",
  • "enforced_mounts": { }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

Delete a single project deployment target

Delete a single deployment target configuration associated with a specific project.

Authorizations:
OAuth2
path Parameters
projectId
required
string
deploymentTargetConfigurationId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

System Information

{schemes}://api.upsun.com/projects/{projectId}/deployments/{deploymentTargetConfigurationId}

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}

System Information

These endpoints can be used to retrieve low-level information and interact with the @@ -3939,13 +3933,13 @@

Using the Access Token

" class="sc-eVqvcJ sc-fszimp kIppRw fOdxau">

Output information for the project.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "image": "string",
  • "started_at": "2019-08-24T14:15:22Z"
}

Restart the Git server

{schemes}://api.upsun.com/projects/{projectId}/system

Response samples

Content type
application/json
{
  • "version": "string",
  • "image": "string",
  • "started_at": "2019-08-24T14:15:22Z"
}

Restart the Git server

Force the Git server to restart.

Authorizations:
OAuth2
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}
+
{schemes}://api.upsun.com/projects/{projectId}/system/restart

Response samples

Content type
application/json
{
  • "status": "string",
  • "code": 0
}