From 6d46f6ec1a4a295d3f384519665cf980c54ad8f7 Mon Sep 17 00:00:00 2001 From: gilzow <2332956+gilzow@users.noreply.github.com> Date: Wed, 4 Feb 2026 03:47:44 +0000 Subject: [PATCH] Update API Docs --- shared/pages/api-internal.html | 310 ++- shared/pages/api.html | 54 +- shared/pages/openapispec-upsun-internal.json | 2148 +++++++++++++++--- shared/pages/openapispec-upsun-internal.yaml | 1917 +++++++++++++--- shared/pages/openapispec-upsun.json | 50 +- shared/pages/openapispec-upsun.yaml | 34 +- 6 files changed, 3782 insertions(+), 731 deletions(-) diff --git a/shared/pages/api-internal.html b/shared/pages/api-internal.html index f0749175b1..892689b074 100644 --- a/shared/pages/api-internal.html +++ b/shared/pages/api-internal.html @@ -24,7 +24,7 @@ -
Upsun logo
API docs by Redocly
Upsun logo
API docs by Redocly
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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:
BearerAuth
query Parameters
object (StringFilter)

Allows filtering by id using one or more operators.

@@ -408,7 +408,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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:
BearerAuth
header Parameters
X-Platform-Vendor
string

[Internal] The vendor.

@@ -426,8 +426,8 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

[Internal] The organization capabilities.

netsuite_id
string

[Internal] The Netsuite ID.

-
billing_account_id
string

[Internal] The Billing Account ID.

+
billing_profile_id
string

[Internal] The Billing Profile ID.

billing_legacy
boolean

[Internal] Whether the account is billed with the legacy system.

security_contact
string <email>
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Forbidden

Request samples

Content type
application/json
{
  • "type": "fixed",
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  • "name": "string",
  • "label": "string",
  • "country": "st",
  • "capabilities": [
    ],
  • "netsuite_id": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active"
}

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",
  • "netsuite_id": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "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",
  • "capabilities": [
    ],
  • "netsuite_id": "string",
  • "billing_profile_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active"
}

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",
  • "netsuite_id": "string",
  • "billing_profile_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get organization

Retrieves the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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",
  • "netsuite_id": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "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",
  • "netsuite_id": "string",
  • "billing_profile_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update organization

Updates the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -478,8 +478,8 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

[Internal] The vendor.

netsuite_id
string

[Internal] The Netsuite ID.

-
billing_account_id
string

[Internal] The Billing Account ID.

+
billing_profile_id
string

[Internal] The Billing Profile ID.

billing_legacy
boolean

[Internal] Whether the account is billed with the legacy system.

security_contact
string <email>
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Request samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "country": "st",
  • "capabilities": [
    ],
  • "vendor": "string",
  • "netsuite_id": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active"
}

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",
  • "netsuite_id": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "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",
  • "capabilities": [
    ],
  • "vendor": "string",
  • "netsuite_id": "string",
  • "billing_profile_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active"
}

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",
  • "netsuite_id": "string",
  • "billing_profile_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete organization

Deletes the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -536,7 +536,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Request samples

Content type
application/json
{
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05"
}

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",
  • "netsuite_id": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

[Internal] Debug organization access

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

Request samples

Content type
application/json
{
  • "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05"
}

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",
  • "netsuite_id": "string",
  • "billing_profile_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

[Internal] Debug organization access

Outputs member access info from Auth and Organizations, and whether it matches.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -764,8 +764,8 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Allows filtering by agency_site using one or more operators.

object (StringFilter)

Allows filtering by dedicated_tag using one or more operators.

-
object (StringFilter)

Allows filtering by billing_account_id using one or more operators.

+
object (StringFilter)

Allows filtering by billing_profile_id using one or more operators.

object (StringFilter)

Allows filtering by status using one or more operators.

object (DateTimeFilter)
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

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

List projects

{schemes}://api.upsun.com/organization-projects

Response samples

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

List projects

Retrieves a list of projects for the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -830,7 +830,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

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

Create project

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

Response samples

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

Create project

Creates a new project in the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -874,7 +874,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Service Unavailable

Request samples

Content type
application/json
{
  • "organization_id": "string",
  • "region": "string",
  • "title": "string",
  • "type": "grid",
  • "plan": "string",
  • "default_branch": "string",
  • "options_url": "string",
  • "options_custom": { },
  • "cse_notes": "string",
  • "support_tier": "string",
  • "dedicated_tag": "string",
  • "fastly_service_ids": [
    ],
  • "edgee_org_id": "string",
  • "edgee_project_id": "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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_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",
  • "options_url": "string",
  • "options_custom": { },
  • "cse_notes": "string",
  • "support_tier": "string",
  • "dedicated_tag": "string",
  • "fastly_service_ids": [
    ],
  • "edgee_org_id": "string",
  • "edgee_project_id": "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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

Get project

Retrieves the specified project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -888,7 +888,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

Update project

Updates the specified project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -916,8 +916,8 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

[Internal] The organization id of the edgee service.

edgee_project_id
string

[Internal] The project id of the edgee service.

-
billing_account_id
string

[Internal] The billing account related to the project.

+
billing_profile_id
string

[Internal] The billing profile related to the project.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "plan": "string",
  • "type": "grid",
  • "timezone": "string",
  • "cse_notes": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "dedicated_tag": "string",
  • "fastly_service_ids": [
    ],
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

Delete project

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

Request samples

Content type
application/json
{
  • "title": "string",
  • "plan": "string",
  • "type": "grid",
  • "timezone": "string",
  • "cse_notes": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "dedicated_tag": "string",
  • "fastly_service_ids": [
    ],
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

Delete project

Deletes the specified project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -960,7 +960,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Reume project

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

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Reume project

Resumes the specified suspended project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -974,7 +974,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Lock project

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

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Lock project

Locks the specified project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -988,7 +988,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Unlock project

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

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Unlock project

Unlocks the specified project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1002,7 +1002,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Sync project

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

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Sync project

Pushes information about the specified project to its git server.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -1016,7 +1016,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_account_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Transfer project

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

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",
  • "options_url": "string",
  • "agency_site": true,
  • "support_tier": "string",
  • "options_custom": { },
  • "trial_plan": true,
  • "project_ui": "string",
  • "locked": true,
  • "cse_notes": "string",
  • "dedicated_tag": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "string",
  • "billing_profile_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "activities": [
    ],
  • "fastly_service_ids": [
    ],
  • "project_options": {
    },
  • "_links": {
    }
}

[Internal] Transfer project

Transfers the specified project to another organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -3712,7 +3712,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Request samples

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

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",
  • "netsuite_id": "string",
  • "billing_account_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

API Tokens

List a user's API tokens

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

Request samples

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

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",
  • "netsuite_id": "string",
  • "billing_profile_id": "string",
  • "billing_legacy": true,
  • "security_contact": "user@example.com",
  • "notes": "string",
  • "status": "active",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

API Tokens

List a user's API tokens

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

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

The ID of the user.

@@ -4614,7 +4614,17 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Check result with error message if presented

Response samples

Content type
application/json
{
  • "can_update": true,
  • "message": "string",
  • "required_action": { }
}

[Internal] Checks if a project is allowed to be transferred to a specific organization.

Authorizations:
BearerAuth
path Parameters
subscriptionId
required
string
{schemes}://api.upsun.com/subscriptions/{subscriptionId}/can-update

Response samples

Content type
application/json
{
  • "can_update": true,
  • "message": "string",
  • "required_action": { }
}

Checks if the user can afford the requested resources.

Authorizations:
BearerAuth
path Parameters
subscriptionId
required
string

The ID of the subscription

+
Request Body schema: application/json
object

A map of resource keys to quantities (both strings).

+

Responses

Request samples

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

[Internal] Checks if a project is allowed to be transferred to a specific organization.

Authorizations:
BearerAuth
path Parameters
subscriptionId
required
string

The ID of the subscription

query Parameters
target_organization
required
string

[Internal] The target organization ID desired to own the project after transfer.

@@ -4622,7 +4632,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Check result with error message if presented

Response samples

Content type
application/json
{
  • "can_transfer": true,
  • "message": "string",
  • "required_action": { }
}

Estimate the price of a new subscription

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/subscriptions/{subscriptionId}/can-transfer

Response samples

Content type
application/json
{
  • "can_transfer": true,
  • "message": "string",
  • "required_action": { }
}

Estimate the price of a new subscription

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

query Parameters
plan
required
string

The plan type of the subscription.

@@ -4644,7 +4654,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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:
BearerAuth
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:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

header Parameters
X-Platform-Vendor
string

[Internal] The vendor.

@@ -4656,7 +4666,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

Content type
application/json
{
  • "can_create": true,
  • "message": "string",
  • "required_action": {
    }
}

Estimate the price of a subscription

Authorizations:
BearerAuth
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:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -4678,7 +4688,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Forbidden

Response samples

Content type
application/json
{
  • "plan": "string",
  • "user_licenses": "string",
  • "environments": "string",
  • "storage": "string",
  • "total": "string",
  • "options": { }
}

[Internal] Estimate the price of a fixed subscription as if it were owned by a flexible org.

Authorizations:
BearerAuth
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": { }
}

[Internal] Estimate the price of a fixed subscription as if it were owned by a flexible org.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -4694,7 +4704,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Forbidden

Response samples

Content type
application/json
{
  • "components": {
    },
  • "plan": {
    },
  • "resources_total": {
    },
  • "total": {
    },
  • "additionalProperties": {
    }
}

[Internal] Get the environment caps

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/flex-calc

Response samples

Content type
application/json
{
  • "components": {
    },
  • "plan": {
    },
  • "resources_total": {
    },
  • "total": {
    },
  • "additionalProperties": {
    }
}

[Internal] Get the environment caps

Retrieves the environment caps of a project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -4708,7 +4718,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "cpu": 0,
  • "memory": "string",
  • "storage": 0,
  • "environments": 0
}

[Internal] Create a new environment cap

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/caps

Response samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "cpu": 0,
  • "memory": "string",
  • "storage": 0,
  • "environments": 0
}

[Internal] Create a new environment cap

Creates a new environment cap for the given project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -4736,7 +4746,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Request samples

Content type
application/json
{
  • "type": "env-type",
  • "name": "string",
  • "storage": 0,
  • "environments": 0,
  • "memory": 0,
  • "cpu": 0,
  • "resource_preset": "Small"
}

Response samples

Content type
application/problem+json
{
  • "error": "string"
}

[Internal] Get an environment type cap

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/caps

Request samples

Content type
application/json
{
  • "type": "env-type",
  • "name": "string",
  • "storage": 0,
  • "environments": 0,
  • "memory": 0,
  • "cpu": 0,
  • "resource_preset": "Small"
}

Response samples

Content type
application/problem+json
{
  • "error": "string"
}

[Internal] Get an environment type cap

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -4752,7 +4762,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "cpu": 0,
  • "memory": "string",
  • "storage": 0,
  • "environments": 0
}

[Internal] Update an environment cap

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/caps/{caps_type}/{env_type}

Response samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "cpu": 0,
  • "memory": "string",
  • "storage": 0,
  • "environments": 0
}

[Internal] Update an environment cap

Updates an environment cap for the given project.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -4784,7 +4794,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Request samples

Content type
application/json
{
  • "type": "env-type",
  • "name": "string",
  • "storage": 0,
  • "environments": 0,
  • "memory": 0,
  • "cpu": 0,
  • "resource_preset": "Small"
}

Response samples

Content type
application/problem+json
{
  • "error": "string"
}

[Internal] Delete and environment cap

{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/caps/{caps_type}/{env_type}

Request samples

Content type
application/json
{
  • "type": "env-type",
  • "name": "string",
  • "storage": 0,
  • "environments": 0,
  • "memory": 0,
  • "cpu": 0,
  • "resource_preset": "Small"
}

Response samples

Content type
application/problem+json
{
  • "error": "string"
}

[Internal] Delete and environment cap

Deletes the specified environment cap.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -4804,7 +4814,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

Content type
application/problem+json
{
  • "error": "string"
}

[Internal] Get all the environment caps of a project

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/caps/{caps_type}/{env_type}

Response samples

Content type
application/problem+json
{
  • "error": "string"
}

[Internal] Get all the environment caps of a project

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -4818,7 +4828,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "cpu": 0,
  • "memory": "string",
  • "storage": 0,
  • "environments": 0
}

Get current usage for a subscription

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>
{schemes}://api.upsun.com/organizations/{organization_id}/subscriptions/{subscription_id}/caps/{caps_type}

Response samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "cpu": 0,
  • "memory": "string",
  • "storage": 0,
  • "environments": 0
}

Get current usage for a subscription

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -4834,7 +4844,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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:
BearerAuth
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:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

subscription_id
required
string

The ID of the subscription.

@@ -4846,7 +4856,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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:
BearerAuth
path Parameters
organization_id
required
string
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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:
BearerAuth
path Parameters
organization_id
required
string
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -4924,7 +4934,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

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

Create subscription

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

Response samples

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

Create subscription

Creates a subscription for the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -4970,7 +4980,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Request samples

Content type
application/json
{
  • "plan": "string",
  • "project_region": "string",
  • "project_title": "string",
  • "options_url": "string",
  • "options_custom": { },
  • "default_branch": "string",
  • "environments": 0,
  • "storage": 0,
  • "project_notes": "string",
  • "support_tier": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "hipaa": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "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_notes": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "options_url": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "invoiced": true,
  • "support_tier": "string",
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "locked": true,
  • "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",
  • "options_custom": { },
  • "default_branch": "string",
  • "environments": 0,
  • "storage": 0,
  • "project_notes": "string",
  • "support_tier": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "hipaa": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "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_notes": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "options_url": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "invoiced": true,
  • "support_tier": "string",
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "locked": true,
  • "green": true
}

Get subscription

Retrieves a subscription for the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -4986,7 +4996,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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_notes": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "options_url": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "invoiced": true,
  • "support_tier": "string",
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "locked": true,
  • "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_notes": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "options_url": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "invoiced": true,
  • "support_tier": "string",
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "locked": true,
  • "green": true
}

Update subscription

Updates a subscription for the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -5042,7 +5052,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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",
  • "project_notes": "string",
  • "support_tier": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "hipaa": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "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_notes": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "options_url": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "invoiced": true,
  • "support_tier": "string",
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "locked": true,
  • "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",
  • "project_notes": "string",
  • "support_tier": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "hipaa": "string",
  • "edgee_org_id": "string",
  • "edgee_project_id": "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_notes": "string",
  • "project_ui": "string",
  • "project_options": {
    },
  • "options_url": "string",
  • "enterprise_tag": "string",
  • "agency_site": true,
  • "invoiced": true,
  • "support_tier": "string",
  • "hipaa": true,
  • "is_trial_plan": true,
  • "services": [
    ],
  • "locked": true,
  • "green": true
}

Delete subscription

Deletes a subscription for the specified organization.

Authorizations:
BearerAuth
path Parameters
organization_id
required
string <ulid>

The ID of the organization.

@@ -5058,7 +5068,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

Content type
application/problem+json
{
  • "error": "string"
}

Orders

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

Response samples

Content type
application/problem+json
{
  • "error": "string"
}

Orders

These endpoints can be used to retrieve order information from our billing @@ -5162,21 +5172,19 @@

Using the Access Token

">

These endpoints can be used to retrieve invoices from our billing system. An invoice of type "invoice" is generated automatically every month, if the customer has active projects. Invoices of type "credit_memo" are a result of manual action when there was a refund or an invoice correction.

-

[Internal] List invoices

[Internal] List all invoices

Retrieves a paginated list of invoices for the specified billing profile.

-

This endpoint returns all invoices associated with a billing profile, including -both current and historical invoices. Results are returned in reverse chronological -order (newest first) by default.

-

Note: This is a BillingBridge (new billing system middleware) endpoint, +" class="sc-iKOlBD sc-cCzKKD cslxVo fFQqWu">

Retrieves a paginated and filterable list of invoices across all billing profiles.

+

This endpoint returns all invoices that the authenticated user has access to, +with support for filtering by various criteria. Results are returned in reverse +chronological order (newest first) by default.

+

Note: This is a BillingBridge (new billing system middleware) endpoint, which is still in the development phase. API behavior may change.

-
Authorizations:
BearerAuth
path Parameters
billing_profile_id
required
string

The ID of the billing profile.

-
query Parameters
page[size]
integer [ 1 .. 100 ]
Default: null
Authorizations:
BearerAuth
query Parameters
page[size]
integer [ 1 .. 100 ]
Default: null

Number of invoices per page

page[after]
string

Cursor for fetching the next page. This is automatically generated as necessary and provided in HAL links (_links); it should not be constructed externally.

@@ -5186,6 +5194,8 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Filter by invoice status (exact match). Case-insensitive - will be converted to uppercase.

filter[type][eq]
string
Enum: "invoice" "legacy_invoice"

Filter by invoice type (exact match)

+
filter[owner_type][eq]
string
Enum: "billing_profile" "organization"

Filter by owner type (exact match)

filter[invoice_date][gte]
string <date>
Example: filter[invoice_date][gte]=2026-01-01

Filter by invoice date greater than or equal to specified date

filter[invoice_date][lte]
string <date>
Example: filter[invoice_date][lte]=2026-01-01
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

OK

[Internal] List all invoices

{schemes}://api.upsun.com/billing/invoices

Response samples

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

[Internal] List invoices

Retrieves a paginated and filterable list of invoices across all billing profiles.

-

This endpoint returns all invoices that the authenticated user has access to, -with support for filtering by various criteria. Results are returned in reverse -chronological order (newest first) by default.

-

Note: This is a BillingBridge (new billing system middleware) endpoint, +" class="sc-iKOlBD sc-cCzKKD cslxVo fFQqWu">

Retrieves a paginated list of invoices for the specified billing profile.

+

This endpoint returns all invoices associated with a billing profile, including +both current and historical invoices. Results are returned in reverse chronological +order (newest first) by default.

+

Note: This is a BillingBridge (new billing system middleware) endpoint, which is still in the development phase. API behavior may change.

-
Authorizations:
BearerAuth
query Parameters
page[size]
integer [ 1 .. 100 ]
Default: null
Authorizations:
BearerAuth
path Parameters
billing_profile_id
required
string

The ID of the billing profile.

+
query Parameters
page[size]
integer [ 1 .. 100 ]
Default: null

Number of invoices per page

page[after]
string

Cursor for fetching the next page. This is automatically generated as necessary and provided in HAL links (_links); it should not be constructed externally.

@@ -5224,8 +5234,6 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Filter by invoice status (exact match). Case-insensitive - will be converted to uppercase.

filter[type][eq]
string
Enum: "invoice" "legacy_invoice"

Filter by invoice type (exact match)

-
filter[owner_type][eq]
string
Enum: "billing_profile" "organization"

Filter by owner type (exact match)

filter[invoice_date][gte]
string <date>
Example: filter[invoice_date][gte]=2026-01-01

Filter by invoice date greater than or equal to specified date

filter[invoice_date][lte]
string <date>
Example: filter[invoice_date][lte]=2026-01-01
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

OK

Response samples

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

[Internal] Get invoice

{schemes}://api.upsun.com/billing/{billing_profile_id}/invoices

Response samples

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

[Internal] Get invoice

Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

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

[Internal] Get billing alert configuration

{schemes}://api.upsun.com/billing/{billing_profile_id}/invoices/{invoice_id}/payments

Response samples

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

[Internal] Get billing alert configuration

Retrieves billing alert configuration for the specified billing profile. NOTE-- This is a BillingBridge (new billing system middleware) endpoint, which is still in the development phase.

Authorizations:
BearerAuth
path Parameters
billing_profile_id
required
string

The ID of the billing profile.

@@ -5800,7 +5810,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

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:
BearerAuth
query Parameters
object (StringFilter)

Allows filtering by available using one or more operators.

@@ -5922,7 +5932,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Forbidden

Response samples

Content type
application/json
[
  • {
    }
]

[Internal] Create data center

{schemes}://api.upsun.com/data-centers

Response samples

Content type
application/json
[
  • {
    }
]

[Internal] Create data center

Creates a new data center.

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string (DataCenterName)

The name of the data center.

@@ -5936,8 +5946,10 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

The provider of the data center.

zone
required
string (DataCenterZone)

The environment impact zone of the data center.

-
carbon_intensity
required
integer (DataCenterCarbonIntensity)
carbon_intensity
required
number (DataCenterCarbonIntensity)

The environment impact carbon intensity of the data center.

+
carbon_intensity_source
required
string (DataCenterCarbonIntensitySource)

The source of the carbon intensity data for the data center.

green
required
boolean (DataCenterGreen)

The environment impact green of the data center.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "green": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "green": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[Internal] Get data center

{schemes}://api.upsun.com/data-centers

Request samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "carbon_intensity_source": "string",
  • "green": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "carbon_intensity_source": "string",
  • "green": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[Internal] Get data center

Retrieves the specified data center.

Authorizations:
BearerAuth
path Parameters
data_center_name
required
string

The name of the data center.

@@ -5962,7 +5974,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Not Found

Response samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "green": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[Internal] Update data center

{schemes}://api.upsun.com/data-centers/{data_center_name}

Response samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "carbon_intensity_source": "string",
  • "green": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[Internal] Update data center

Updates the specified data center.

Authorizations:
BearerAuth
path Parameters
data_center_name
required
string

The name of the data center.

@@ -5976,8 +5988,10 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

The provider of the data center.

zone
string (DataCenterZone)

The environment impact zone of the data center.

-
carbon_intensity
integer (DataCenterCarbonIntensity)
carbon_intensity
number (DataCenterCarbonIntensity)

The environment impact carbon intensity of the data center.

+
carbon_intensity_source
string (DataCenterCarbonIntensitySource)

The source of the carbon intensity data for the data center.

green
boolean (DataCenterGreen)

The environment impact green of the data center.

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "green": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "green": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[Internal] Delete data center

{schemes}://api.upsun.com/data-centers/{data_center_name}

Request samples

Content type
application/json
{
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "carbon_intensity_source": "string",
  • "green": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "logo": "string",
  • "location": "string",
  • "provider": "string",
  • "zone": "string",
  • "carbon_intensity": 0,
  • "carbon_intensity_source": "string",
  • "green": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

[Internal] Delete data center

Deletes the specified data center.

Authorizations:
BearerAuth
path Parameters
data_center_name
required
string

The name of the data center.

@@ -6026,7 +6040,91 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Too much data fetched - The query is attempting to retrieve too much data. Please narrow down the query by reducing the time range or adding more specific filters to retrieve less data.

Response samples

Content type
application/json
{
  • "_grain": 300,
  • "_from": 1704067200,
  • "_to": 1704153600,
  • "_project_id": "abc123def456",
  • "_environment_id": "main",
  • "_environment_type": "production",
  • "_branch_machine_name": "main",
  • "_top_urls_count": 10,
  • "data": {
    }
}

[Internal] Get HTTP traffic overview with top URLs and time-series metrics

{schemes}://api.upsun.com/platformsh-api/{projectId}/environments/{environmentId}/observability/http-metrics/overview

Response samples

Content type
application/json
{
  • "_grain": 300,
  • "_from": 1704067200,
  • "_to": 1704153600,
  • "_project_id": "abc123def456",
  • "_environment_id": "main",
  • "_environment_type": "production",
  • "_branch_machine_name": "main",
  • "_top_urls_count": 10,
  • "data": {
    }
}

[Internal] Get HTTP traffic timeline grouped by IP addresses

Returns HTTP traffic analytics grouped by IP address with top IPs ranked by impact (response time × request count). Provides percentage-based metrics showing each IP's share of total traffic, along with time-series data. Use top_count parameter to control result size (default: 10, max: 100). Response includes per-IP metrics with percentage of total requests and timestamped traffic data showing IP distribution over time.

+
Authorizations:
BearerAuth
path Parameters
projectId
required
string[a-z0-9]+
Example: abc123def456

The unique identifier of the Upsun project

+
environmentId
required
string.+
Example: main

The environment identifier

+
query Parameters
from
required
integer <int64>
Example: from=1704067200

Start timestamp for the time range (Unix timestamp in seconds)

+
to
required
integer <int64>
Example: to=1704153600

End timestamp for the time range (Unix timestamp in seconds)

+
top_count
integer [ 1 .. 100 ]
Default: null
Example: top_count=20

Number of top IPs to return (default: 10, max: 100)

+
methods[]
Array of strings
Items Enum: "GET" "POST" "PUT" "PATCH" "DELETE" "HEAD" "OPTIONS"
Example: methods[]=GET

Filter by HTTP methods. Can be specified multiple times for multiple values (e.g., ?methods[]=GET&methods[]=POST). Use methods_mode to control inclusion/exclusion behavior.

+
methods_mode
string
Default: null
Enum: "1" "-1"
Example: methods_mode=1

Filter mode for methods parameter. "1" (additive) includes only specified methods. "-1" (subtractive, default) excludes specified methods and includes all others.

+
domains[]
Array of strings
Example: domains[]=api.example.com

Filter by request domains/hosts. Can be specified multiple times for multiple values (e.g., ?domains[]=api.example.com&domains[]=www.example.com). Use domains_mode to control inclusion/exclusion behavior.

+
domains_mode
string
Default: null
Enum: "1" "-1"
Example: domains_mode=1

Filter mode for domains parameter. "1" (additive) includes only specified domains. "-1" (subtractive, default) excludes specified domains and includes all others.

+
code_slots[]
Array of strings
Items Enum: "1XX" "2XX" "3XX" "4XX" "5XX"
Example: code_slots[]=2XX

Filter by HTTP status code groups. Can be specified multiple times for multiple values (e.g., ?code_slots[]=4XX&code_slots[]=5XX). Use code_slots_mode to control inclusion/exclusion behavior.

+
code_slots_mode
string
Default: null
Enum: "1" "-1"
Example: code_slots_mode=1

Filter mode for code_slots parameter. "1" (additive) includes only specified code groups. "-1" (subtractive, default) excludes specified code groups and includes all others.

+
codes[]
Array of strings
Example: codes[]=200

Filter by specific HTTP status codes. Can be specified multiple times for multiple values (e.g., ?codes[]=200&codes[]=404). Use codes_mode to control inclusion/exclusion behavior.

+
codes_mode
string
Default: null
Enum: "1" "-1"
Example: codes_mode=1

Filter mode for codes parameter. "1" (additive) includes only specified codes. "-1" (subtractive, default) excludes specified codes and includes all others.

+
request_duration_slots[]
Array of strings
Items Enum: "0-50" "50-100" "100-200" "200-400" "400-800" "800-1600" "1600+"
Example: request_duration_slots[]=0-50

Filter by response time ranges (in milliseconds). Can be specified multiple times for multiple values (e.g., ?request_duration_slots[]=0-50&request_duration_slots[]=1600+). Use request_duration_slots_mode to control inclusion/exclusion behavior.

+
request_duration_slots_mode
string
Default: null
Enum: "1" "-1"
Example: request_duration_slots_mode=1

Filter mode for request_duration_slots parameter. "1" (additive) includes only specified duration ranges. "-1" (subtractive, default) excludes specified duration ranges and includes all others.

+

Responses

Response samples

Content type
application/json
{
  • "_grain": 300,
  • "_from": 1704067200,
  • "_to": 1704153600,
  • "_project_id": "abc123def456",
  • "_environment_id": "main",
  • "_environment_type": "production",
  • "_branch_machine_name": "main",
  • "_top_count": 10,
  • "_methods": [
    ],
  • "_methods_mode": "1",
  • "_domains": [
    ],
  • "_domains_mode": "1",
  • "_code_slots": [
    ],
  • "_code_slots_mode": "1",
  • "_codes": [
    ],
  • "_codes_mode": "1",
  • "_request_duration_slots": [
    ],
  • "_request_duration_slots_mode": "1",
  • "data": {
    }
}

[Internal] Get HTTP traffic timeline grouped by User Agents

Returns HTTP traffic analytics grouped by User Agent with top User Agents ranked by impact (response time × request count). Provides percentage-based metrics showing each User Agent's share of total traffic, along with time-series data. Use top_count parameter to control result size (default: 10, max: 100). Response includes per-User Agent metrics with percentage of total requests and timestamped traffic data showing User Agent distribution over time.

+
Authorizations:
BearerAuth
path Parameters
projectId
required
string[a-z0-9]+
Example: abc123def456

The unique identifier of the Upsun project

+
environmentId
required
string.+
Example: main

The environment identifier

+
query Parameters
from
required
integer <int64>
Example: from=1704067200

Start timestamp for the time range (Unix timestamp in seconds)

+
to
required
integer <int64>
Example: to=1704153600

End timestamp for the time range (Unix timestamp in seconds)

+
top_count
integer [ 1 .. 100 ]
Default: null
Example: top_count=20

Number of top User Agents to return (default: 10, max: 100)

+
methods[]
Array of strings
Items Enum: "GET" "POST" "PUT" "PATCH" "DELETE" "HEAD" "OPTIONS"
Example: methods[]=GET

Filter by HTTP methods. Can be specified multiple times for multiple values (e.g., ?methods[]=GET&methods[]=POST). Use methods_mode to control inclusion/exclusion behavior.

+
methods_mode
string
Default: null
Enum: "1" "-1"
Example: methods_mode=1

Filter mode for methods parameter. "1" (additive) includes only specified methods. "-1" (subtractive, default) excludes specified methods and includes all others.

+
domains[]
Array of strings
Example: domains[]=api.example.com

Filter by request domains/hosts. Can be specified multiple times for multiple values (e.g., ?domains[]=api.example.com&domains[]=www.example.com). Use domains_mode to control inclusion/exclusion behavior.

+
domains_mode
string
Default: null
Enum: "1" "-1"
Example: domains_mode=1

Filter mode for domains parameter. "1" (additive) includes only specified domains. "-1" (subtractive, default) excludes specified domains and includes all others.

+
code_slots[]
Array of strings
Items Enum: "1XX" "2XX" "3XX" "4XX" "5XX"
Example: code_slots[]=2XX

Filter by HTTP status code groups. Can be specified multiple times for multiple values (e.g., ?code_slots[]=4XX&code_slots[]=5XX). Use code_slots_mode to control inclusion/exclusion behavior.

+
code_slots_mode
string
Default: null
Enum: "1" "-1"
Example: code_slots_mode=1

Filter mode for code_slots parameter. "1" (additive) includes only specified code groups. "-1" (subtractive, default) excludes specified code groups and includes all others.

+
codes[]
Array of strings
Example: codes[]=200

Filter by specific HTTP status codes. Can be specified multiple times for multiple values (e.g., ?codes[]=200&codes[]=404). Use codes_mode to control inclusion/exclusion behavior.

+
codes_mode
string
Default: null
Enum: "1" "-1"
Example: codes_mode=1

Filter mode for codes parameter. "1" (additive) includes only specified codes. "-1" (subtractive, default) excludes specified codes and includes all others.

+
request_duration_slots[]
Array of strings
Items Enum: "0-50" "50-100" "100-200" "200-400" "400-800" "800-1600" "1600+"
Example: request_duration_slots[]=0-50

Filter by response time ranges (in milliseconds). Can be specified multiple times for multiple values (e.g., ?request_duration_slots[]=0-50&request_duration_slots[]=1600+). Use request_duration_slots_mode to control inclusion/exclusion behavior.

+
request_duration_slots_mode
string
Default: null
Enum: "1" "-1"
Example: request_duration_slots_mode=1

Filter mode for request_duration_slots parameter. "1" (additive) includes only specified duration ranges. "-1" (subtractive, default) excludes specified duration ranges and includes all others.

+

Responses

Response samples

Content type
application/json
{
  • "_grain": 300,
  • "_from": 1704067200,
  • "_to": 1704153600,
  • "_project_id": "abc123def456",
  • "_environment_id": "main",
  • "_environment_type": "production",
  • "_branch_machine_name": "main",
  • "_top_count": 10,
  • "_methods": [
    ],
  • "_methods_mode": "1",
  • "_domains": [
    ],
  • "_domains_mode": "1",
  • "_code_slots": [
    ],
  • "_code_slots_mode": "1",
  • "_codes": [
    ],
  • "_codes_mode": "1",
  • "_request_duration_slots": [
    ],
  • "_request_duration_slots_mode": "1",
  • "data": {
    }
}

[Internal] Get HTTP traffic overview with top URLs and time-series metrics

Returns HTTP traffic analytics with top URLs ranked by impact (response time × request count), aggregated metrics (average, median, p96 response times in milliseconds), status code distributions, and time-series data. Use top_urls_count parameter to control result size (default: 10, max: 100). Response includes per-URL metrics grouped by "METHOD-URL" keys (e.g., "GET-https://example.com/api/products") and timestamped traffic data with request/response sizes in bytes.

Authorizations:
BearerAuth
path Parameters
projectId
required
string[a-z0-9]+
Example: abc123def456

The unique identifier of the Upsun project

@@ -6036,8 +6134,28 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Start timestamp for the time range (Unix timestamp in seconds)

to
required
integer <int64>
Example: to=1704153600

End timestamp for the time range (Unix timestamp in seconds)

-
top_urls_count
integer [ 1 .. 100 ]
Default: null
Example: top_urls_count=20
top_count
integer [ 1 .. 100 ]
Default: null
Example: top_count=20

Number of top URLs to return (default: 10, max: 100)

+
methods[]
Array of strings
Items Enum: "GET" "POST" "PUT" "PATCH" "DELETE" "HEAD" "OPTIONS"
Example: methods[]=GET

Filter by HTTP methods. Can be specified multiple times for multiple values (e.g., ?methods[]=GET&methods[]=POST). Use methods_mode to control inclusion/exclusion behavior.

+
methods_mode
string
Default: null
Enum: "1" "-1"
Example: methods_mode=1

Filter mode for methods parameter. "1" (additive) includes only specified methods. "-1" (subtractive, default) excludes specified methods and includes all others.

+
domains[]
Array of strings
Example: domains[]=api.example.com

Filter by request domains/hosts. Can be specified multiple times for multiple values (e.g., ?domains[]=api.example.com&domains[]=www.example.com). Use domains_mode to control inclusion/exclusion behavior.

+
domains_mode
string
Default: null
Enum: "1" "-1"
Example: domains_mode=1

Filter mode for domains parameter. "1" (additive) includes only specified domains. "-1" (subtractive, default) excludes specified domains and includes all others.

+
code_slots[]
Array of strings
Items Enum: "1XX" "2XX" "3XX" "4XX" "5XX"
Example: code_slots[]=2XX

Filter by HTTP status code groups. Can be specified multiple times for multiple values (e.g., ?code_slots[]=4XX&code_slots[]=5XX). Use code_slots_mode to control inclusion/exclusion behavior.

+
code_slots_mode
string
Default: null
Enum: "1" "-1"
Example: code_slots_mode=1

Filter mode for code_slots parameter. "1" (additive) includes only specified code groups. "-1" (subtractive, default) excludes specified code groups and includes all others.

+
codes[]
Array of strings
Example: codes[]=200

Filter by specific HTTP status codes. Can be specified multiple times for multiple values (e.g., ?codes[]=200&codes[]=404). Use codes_mode to control inclusion/exclusion behavior.

+
codes_mode
string
Default: null
Enum: "1" "-1"
Example: codes_mode=1

Filter mode for codes parameter. "1" (additive) includes only specified codes. "-1" (subtractive, default) excludes specified codes and includes all others.

+
request_duration_slots[]
Array of strings
Items Enum: "0-50" "50-100" "100-200" "200-400" "400-800" "800-1600" "1600+"
Example: request_duration_slots[]=0-50

Filter by response time ranges (in milliseconds). Can be specified multiple times for multiple values (e.g., ?request_duration_slots[]=0-50&request_duration_slots[]=1600+). Use request_duration_slots_mode to control inclusion/exclusion behavior.

+
request_duration_slots_mode
string
Default: null
Enum: "1" "-1"
Example: request_duration_slots_mode=1

Filter mode for request_duration_slots parameter. "1" (additive) includes only specified duration ranges. "-1" (subtractive, default) excludes specified duration ranges and includes all others.

Responses

[Internal] Get observability API entrypoint with HATEOAS navigation and retention policies

{schemes}://api.upsun.com/platformsh-api/{projectId}/environments/{environmentId}/observability/http-metrics/timeline/urls

Response samples

Content type
application/json
{
  • "_grain": 300,
  • "_from": 1704067200,
  • "_to": 1704153600,
  • "_project_id": "abc123def456",
  • "_environment_id": "main",
  • "_environment_type": "production",
  • "_branch_machine_name": "main",
  • "_top_count": 10,
  • "_methods": [
    ],
  • "_methods_mode": "1",
  • "_domains": [
    ],
  • "_domains_mode": "1",
  • "_code_slots": [
    ],
  • "_code_slots_mode": "1",
  • "_codes": [
    ],
  • "_codes_mode": "1",
  • "_request_duration_slots": [
    ],
  • "_request_duration_slots_mode": "1",
  • "data": {
    },
  • "filters": {
    }
}

[Internal] Get observability API entrypoint with HATEOAS navigation and retention policies

Returns API entrypoint with hypermedia links to all observability endpoints (resources, logs, HTTP traffic, continuous profiling, server metrics) following HATEOAS principles. Includes data retention policies per metric type (retention_period, max_range, recommended_default_range in minutes), environment metadata (project_id, environment_id, environment_type, vendor), and per-service resource links. Use _links for API navigation.

Authorizations:
BearerAuth
path Parameters
projectId
required
string[a-z0-9]+
Example: abc123def456

The unique identifier of the Upsun project

@@ -6060,7 +6178,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Forbidden - Access denied due to insufficient permissions, or the requested project/environment does not exist (to prevent information disclosure)

Response samples

Content type
application/json
{
  • "message": "bonjour, monde!",
  • "project_id": "abc123def456",
  • "branch_machine_name": "main",
  • "environment_id": "main",
  • "environment_type": "production",
  • "vendor": "upsun",
  • "psh_user_identifier": "user@example.com",
  • "_links": {},
  • "retention": {
    },
  • "data_retention": {
    }
}

Logs

[Internal] Get logs overview with time-series severity distribution and available filters

{schemes}://api.upsun.com/platformsh-api/{projectId}/environments/{environmentId}/observability

Response samples

Content type
application/json
{
  • "message": "bonjour, monde!",
  • "project_id": "abc123def456",
  • "branch_machine_name": "main",
  • "environment_id": "main",
  • "environment_type": "production",
  • "vendor": "upsun",
  • "psh_user_identifier": "user@example.com",
  • "_links": {},
  • "retention": {
    },
  • "data_retention": {
    }
}

Logs

[Internal] Get logs overview with time-series severity distribution and available filters

Returns aggregated log entries with time-series severity distribution (emergency, alert, critical, error, warning, notice, info, debug) and available filter fields. Response includes per-timestamp severity counts and field metadata (distinct_values, type, top values with counts) for building filter UIs. Use for monitoring application health and error patterns.

Authorizations:
BearerAuth
path Parameters
projectId
required
string[a-z0-9]+
Example: abc123def456

The unique identifier of the Upsun project

@@ -6118,8 +6236,6 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Start timestamp for the time range (Unix timestamp in seconds)

to
required
integer <int64>
Example: to=1704153600

End timestamp for the time range (Unix timestamp in seconds)

-
ulid
string <ulid>
Deprecated
Example: ulid=01HXYZ123456789ABCDEFGHIJK

Pagination cursor (ULID format) to retrieve next page of results

cursor
string <ulid>
Example: cursor=01HXYZ123456789ABCDEFGHIJK

Pagination cursor (ULID format) to retrieve next page of results

order
string
Default: null
Enum: "asc" "desc"
Example: order=desc
Using the Access Token " class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Too much data fetched - The query is attempting to retrieve too much data. Please narrow down the query by reducing the time range or adding more specific filters to retrieve less data.

Response samples

Content type
application/json
{
  • "_from": 1704067200,
  • "_to": 1704153600,
  • "_order": "desc",
  • "_project_id": "abc123def456",
  • "_environment_id": "main",
  • "_branch_machine_name": "main",
  • "_cursor": "01HXYZ987654321ZYXWVUTSRQP",
  • "_has_more_results": true,
  • "_severities": [
    ],
  • "_severities_mode": "1",
  • "_services": [
    ],
  • "_services_mode": "1",
  • "_instances": [
    ],
  • "_instances_mode": "1",
  • "_hosts": [
    ],
  • "_hosts_mode": "1",
  • "_commands": [
    ],
  • "_commands_mode": "1",
  • "_container_names": [
    ],
  • "_container_names_mode": "1",
  • "_container_images": [
    ],
  • "_container_images_mode": "1",
  • "data": [
    ]
}

[Internal] Get observability API entrypoint with HATEOAS navigation and retention policies

{schemes}://api.upsun.com/platformsh-api/{projectId}/environments/{environmentId}/observability/logs/query

Response samples

Content type
application/json
{
  • "_from": 1704067200,
  • "_to": 1704153600,
  • "_order": "desc",
  • "_project_id": "abc123def456",
  • "_environment_id": "main",
  • "_branch_machine_name": "main",
  • "_cursor": "01HXYZ987654321ZYXWVUTSRQP",
  • "_has_more_results": true,
  • "_severities": [
    ],
  • "_severities_mode": "1",
  • "_services": [
    ],
  • "_services_mode": "1",
  • "_instances": [
    ],
  • "_instances_mode": "1",
  • "_hosts": [
    ],
  • "_hosts_mode": "1",
  • "_commands": [
    ],
  • "_commands_mode": "1",
  • "_container_names": [
    ],
  • "_container_names_mode": "1",
  • "_container_images": [
    ],
  • "_container_images_mode": "1",
  • "data": [
    ]
}

[Internal] Get observability API entrypoint with HATEOAS navigation and retention policies

Returns API entrypoint with hypermedia links to all observability endpoints (resources, logs, HTTP traffic, continuous profiling, server metrics) following HATEOAS principles. Includes data retention policies per metric type (retention_period, max_range, recommended_default_range in minutes), environment metadata (project_id, environment_id, environment_type, vendor), and per-service resource links. Use _links for API navigation.

Authorizations:
BearerAuth
path Parameters
projectId
required
string[a-z0-9]+
Example: abc123def456

The unique identifier of the Upsun project

@@ -6176,7 +6292,7 @@

Using the Access Token

" class="sc-iKOlBD sc-cCzKKD sc-ckdFjQ cslxVo lkEUlo hKuZJA">

Forbidden - Access denied due to insufficient permissions, or the requested project/environment does not exist (to prevent information disclosure)

Response samples

Content type
application/json
{
  • "message": "bonjour, monde!",
  • "project_id": "abc123def456",
  • "branch_machine_name": "main",
  • "environment_id": "main",
  • "environment_type": "production",
  • "vendor": "upsun",
  • "psh_user_identifier": "user@example.com",
  • "_links": {},
  • "retention": {
    },
  • "data_retention": {
    }
}

Project Settings

{schemes}://api.upsun.com/platformsh-api/{projectId}/environments/{environmentId}/observability

Response samples

Content type
application/json
{
  • "message": "bonjour, monde!",
  • "project_id": "abc123def456",
  • "branch_machine_name": "main",
  • "environment_id": "main",
  • "environment_type": "production",
  • "vendor": "upsun",
  • "psh_user_identifier": "user@example.com",
  • "_links": {},
  • "retention": {
    },
  • "data_retention": {
    }
}

Project Settings

Using the Access Token " class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

The Internal Upsun.com API gateway

{schemes}://api.upsun.com/kyc/{organization_id}/payment-score

Response samples

Content type
application/json
{
  • "min_risk": 1,
  • "max_risk": 50,
  • "avg_risk": 33,
  • "num_disputed": 0,
  • "num_success": 0,
  • "num_failed": 0
}