API docs by Redocly

Omnistrate Registration API (2022-09-01-00)

Download OpenAPI specification:Download

REST API for Omnistrate Service Registration

global-api

Common API for all Omnistrate API endpoints

registrationServiceHealth global-api

Registration service health check endpoint

Responses

Response samples

Content type
application/json
{
  • "status": "RUNNING"
}

consumptionServiceHealth global-api

Consumption service health check endpoint

Responses

Response samples

Content type
application/json
{
  • "status": "RUNNING"
}

consumptionServiceVersion global-api

Consumption service version endpoint

Responses

Response samples

Content type
application/json
{
  • "apiVersion": "rjk",
  • "buildCommitSHA": "1234567890abcdef1234567890abcdef12345678",
  • "buildTimestamp": "2020-01-01T00:00:00Z"
}

registrationServiceVersion global-api

Registration service version endpoint

Responses

Response samples

Content type
application/json
{
  • "apiVersion": "75",
  • "buildCommitSHA": "1234567890abcdef1234567890abcdef12345678",
  • "buildTimestamp": "2020-01-01T00:00:00Z"
}

service-api

ListService service-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token",
  • "services": [
    ]
}

CreateService service-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
description
required
string

A brief description of the service

name
required
string

Name of the Service

serviceLogoURL
string <uri>

The logo for the service

Responses

Request samples

Content type
application/json
{
  • "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
  • "name": "MySQL multi-writer service",
  • "serviceLogoURL": "http://fahey.biz/jaquelin.kirlin"
}

Response samples

Content type
application/json
"s-12345678"

DeleteService service-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID to operate on

Responses

DescribeService service-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID to operate on

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-01-01T00:00:00Z",
  • "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
  • "id": "s-12345678",
  • "key": "mysql",
  • "name": "MySQL multi-writer service",
  • "roleType": "admin",
  • "serviceEnvironments": [
    ],
  • "serviceLogoURL": "http://walter.name/arden",
  • "serviceProviderID": "sp-12345678",
  • "serviceProviderName": "Omnistrate, Inc."
}

UpdateService service-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID to operate on

Request Body schema: application/json
required
description
string

A brief description of the service

name
string

Name of the Service

serviceLogoURL
string <uri>

The logo for the service

Responses

Request samples

Content type
application/json
{
  • "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
  • "name": "MySQL multi-writer service",
  • "serviceLogoURL": "http://russeldurgan.com/jerel.crooks"
}

ServiceHealth service-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service

Responses

Response samples

Content type
application/json
{
  • "health": "UP",
  • "id": "s-12345678",
  • "report": {
    }
}

CreateServiceFromComposeSpec service-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
description
required
string

A brief description of the service

fileContent
required
string

Base64 encoded Compose Spec YAML in docker compose format

fileFormat
required
string

MIME type of file format

fileName
required
string

Name of compose spec YAML file that is uploaded

name
required
string

Name of the Service

serviceLogoURL
string <uri>

The logo for the service

Responses

Request samples

Content type
application/json
{
  • "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
  • "fileContent": "Corrupti repellendus vel.",
  • "fileFormat": "text/plain",
  • "fileName": "mysql.yaml",
  • "name": "MySQL multi-writer service",
  • "serviceLogoURL": "http://dooleymoore.info/davion_marvin"
}

Response samples

Content type
application/json
"s-12345678"

service-environment-api

ListServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service this environment belongs to

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service this environment belongs to

Request Body schema: application/json
required
autoApproveSubscription
boolean

Auto approve subscription or not

deploymentConfigId
required
string^(?P<entitytype>dc)-(?P<entityid>[a-zA-Z0-9][...

The deployment configuration ID

description
required
string

A brief description of the service environment

name
required
string

Name of the Service Environment

serviceAuthPublicKey
string

PEM-encoded Public key part of the key used to sign the JWT tokens for the service control plane APIs

sourceEnvironmentId
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...

The ID of the service environment to use for promoting changes to this environment

visibility
string
Enum: "PUBLIC" "PRIVATE"

This parameter is used to configure the visibility of the service control-plane APIs

Responses

Request samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "deploymentConfigId": "dc-12345678",
  • "description": "The production environment for the MySQL multi-writer service",
  • "name": "Production",
  • "serviceAuthPublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
  • "sourceEnvironmentId": "se-12345678",
  • "visibility": "PUBLIC"
}

Response samples

Content type
application/json
"se-12345678"

DeleteServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service this environment belongs to

id
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

The ID of the service environment

Responses

DescribeServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service this environment belongs to

id
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

The ID of the service environment

Responses

Response samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "deploymentConfigId": "dc-12345678",
  • "description": "The production environment for the MySQL multi-writer service",
  • "id": "se-12345678",
  • "key": "production",
  • "name": "Production",
  • "roleType": "admin",
  • "serviceAuthPublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
  • "serviceId": "s-12345678",
  • "sourceEnvironmentId": "se-12345678",
  • "visibility": "PRIVATE"
}

UpdateServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service this environment belongs to

id
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

The ID of the service environment

Request Body schema: application/json
required
autoApproveSubscription
boolean

Auto approve subscription or not

deploymentConfigId
string^(?P<entitytype>dc)-(?P<entityid>[a-zA-Z0-9][...

The deployment configuration ID

description
string

A brief description of the service environment

name
string

Name of the Service Environment

serviceAuthPublicKey
string

PEM-encoded Public key part of the key used to sign the JWT tokens for the service control plane APIs

sourceEnvironmentId
string

The ID of the service environment to use for promoting changes to this environment

visibility
string
Enum: "PUBLIC" "PRIVATE"

This parameter is used to configure the visibility of the service control-plane APIs

Responses

Request samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "deploymentConfigId": "dc-12345678",
  • "description": "The production environment for the MySQL multi-writer service",
  • "name": "Production",
  • "serviceAuthPublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
  • "sourceEnvironmentId": "se-12345678",
  • "visibility": "PRIVATE"
}

PromoteServiceEnvironmentStatus service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service this environment belongs to

id
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

The ID of the service environment

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

PromoteServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service this environment belongs to

id
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

The ID of the service environment

Responses

service-model-api

CreateServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service this model is for

Request Body schema: application/json
required
accountConfigIds
Array of strings[^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...]

The infrastructure account configuration ID list

description
required
string

A brief description of the service model

modelType
required
string
Enum: "OMNISTRATE_HOSTED" "CUSTOMER_HOSTED" "BYOA"

The model type encapsulating this service

name
required
string

Name of the Service Model

serviceApiId
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...

The service API this model is for

Responses

Request samples

Content type
application/json
{
  • "accountConfigIds": [
    ],
  • "description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
  • "modelType": "CUSTOMER_HOSTED",
  • "name": "MySQL multi-writer service hosted model",
  • "serviceApiId": "sa-12345678"
}

Response samples

Content type
application/json
"sm-12345678"

DeleteServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID this model belongs to

id
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

The service model ID

Responses

DescribeServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID this model belongs to

id
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

The service model ID

Responses

Response samples

Content type
application/json
{
  • "accountConfigIds": [
    ],
  • "activeAccountConfigIds": {
    },
  • "description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
  • "id": "sm-12345678",
  • "key": "mysql-multi-writer-service-hosted-model",
  • "modelType": "CUSTOMER_HOSTED",
  • "name": "MySQL multi-writer service hosted model",
  • "productTiers": [
    ],
  • "serviceApiId": "sa-12345678",
  • "serviceId": "s-12345678"
}

UpdateServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID this model belongs to

id
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

The service model ID

Request Body schema: application/json
required
description
string

A brief description of the service model

name
string

Name of the Service Model

Responses

Request samples

Content type
application/json
{
  • "description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
  • "name": "MySQL multi-writer service hosted model"
}

AddAccountConfigToServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID this model belongs to

id
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

The service model ID

Request Body schema: application/json
required
accountConfigId
required
string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...

The infrastructure account configuration ID

Responses

Request samples

Content type
application/json
{
  • "accountConfigId": "ac-12345678"
}

SetActiveAccountConfig service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID this model belongs to

id
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

The service model ID

accountConfigId
required
string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...
Example: ac-12345678

The infrastructure account configuration ID

Responses

ReleaseServiceModelStatus service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID this model belongs to

id
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

The service model ID

Responses

Response samples

Content type
application/json
{
  • "status": "READY"
}

CopyServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID this model belongs to

sourceId
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

The source service model ID

Request Body schema: application/json
required
accountConfigIds
Array of strings[^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...]

The infrastructure account configuration ID list

description
required
string

A brief description of the service model

name
required
string

Name of the Service Model

targetServiceModelType
required
string
Enum: "OMNISTRATE_HOSTED" "CUSTOMER_HOSTED" "BYOA"

The model type encapsulating this service

targetTierType
string
Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY"

Target product tier type

Responses

Request samples

Content type
application/json
{
  • "accountConfigIds": [
    ],
  • "description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
  • "name": "MySQL multi-writer service hosted model",
  • "targetServiceModelType": "CUSTOMER_HOSTED",
  • "targetTierType": "OMNISTRATE_DEDICATED_TENANCY"
}

Response samples

Content type
application/json
"sm-12345678"

ListServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

serviceApiId
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...
Example: sa-12345678

The service API ID

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

product-tier-api

ListProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

serviceModelId
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

Service model ID

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

Request Body schema: application/json
required
awsRegions
Array of strings

The AWS regions that this product tier is available on

description
required
string

A brief description of the product tier

documentation
string

Documentation

gcpRegions
Array of strings

The GCP regions that this product tier is available on

isDisabled
boolean

Create the product tier in a disabled state. Enabling the product tier will let end-customers subscribe and use the service plan.

name
required
string

Name of the product tier

planDescription
required
string

A brief description for the end user of the product tier

pricing
string <binary>

Pricing

serviceModelId
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...

Service model ID

support
string

Support

tierType
required
string
Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY"

Tier type

Responses

Request samples

Content type
application/json
{
  • "awsRegions": [
    ],
  • "description": "A premium product tier",
  • "documentation": "Any documentation",
  • "gcpRegions": [
    ],
  • "isDisabled": false,
  • "name": "Premium",
  • "planDescription": "A premium plan",
  • "pricing": {
    },
  • "serviceModelId": "sm-12345678",
  • "support": "Any support",
  • "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}

Response samples

Content type
application/json
"pt-12345678"

DeleteProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

id
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

Responses

DescribeProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

id
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

Responses

Response samples

Content type
application/json
{
  • "apiGroups": {
    },
  • "awsRegions": [
    ],
  • "description": "A premium product tier",
  • "documentation": "Any documentation",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "gcpRegions": [
    ],
  • "id": "pt-12345678",
  • "isDisabled": false,
  • "key": "premium",
  • "name": "Premium",
  • "planDescription": "A premium plan",
  • "pricing": {
    },
  • "serviceId": "s-12345678",
  • "serviceModelId": "sm-12345678",
  • "support": "Any support",
  • "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}

UpdateProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

id
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

Request Body schema: application/json
required
awsRegions
Array of strings

The AWS regions that this product tier is available on

description
string

A brief description of the product tier

documentation
string

Documentation

gcpRegions
Array of strings

The GCP regions that this product tier is available on

isDisabled
boolean

Update the product tier's state as enabled/disabled. Enabling the product tier will let end-customers subscribe and use the service plan.

name
string

Name of the product tier

planDescription
string

A brief description for the end user of the product tier

pricing
string <binary>

Pricing

support
string

Support

tierType
string
Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY"

Tier type

Responses

Request samples

Content type
application/json
{
  • "awsRegions": [
    ],
  • "description": "A premium product tier",
  • "documentation": "Any documentation",
  • "gcpRegions": [
    ],
  • "isDisabled": false,
  • "name": "Premium",
  • "planDescription": "A premium plan",
  • "pricing": {
    },
  • "support": "Any support",
  • "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}

ListProductTierBillingPlan product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

id
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

Responses

Response samples

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

CreateProductTierBillingPlan product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

id
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
required
boolean

Allow creates when payment not configured

maxNumberofInstances
required
integer <int64>

Maximum number of instances

planName
required
string

Plan name

pricing
required
string <binary>

Pricing in dollars.

Responses

Request samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "maxNumberofInstances": 5,
  • "planName": "STARTER",
  • "pricing": {
    }
}

Response samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "id": "bp-12345678",
  • "maxNumberofInstances": 5,
  • "planName": "STARTER",
  • "pricing": {
    },
  • "productTierId": "pt-12345678",
  • "serviceId": "s-12345678"
}

DisableProductTierFeature product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

id
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

Request Body schema: application/json
required
feature
required
string
Enum: "LOGS" "METRICS" "BILLING" "ALERTS"

Feature to disable

scope
string
Enum: "INTERNAL" "CUSTOMER"

Feature scope

Responses

Request samples

Content type
application/json
{
  • "feature": "BILLING",
  • "scope": "INTERNAL"
}

EnableProductTierFeature product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

id
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

Request Body schema: application/json
required
object

The configuration parameters of the product tier feature

feature
required
string
Enum: "LOGS" "METRICS" "BILLING" "ALERTS"

Feature to enable

scope
string
Enum: "INTERNAL" "CUSTOMER"

Feature scope

Responses

Request samples

Content type
application/json
{
  • "configuration": {
    },
  • "feature": "BILLING",
  • "scope": "INTERNAL"
}

DeleteProductTierBillingPlan product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

id
required
string^(?P<entitytype>bp)-(?P<entityid>[a-zA-Z0-9][...
Example: bp-12345678

Product tier billing plan ID

Responses

DescribeProductTierBillingPlan product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

id
required
string^(?P<entitytype>bp)-(?P<entityid>[a-zA-Z0-9][...
Example: bp-12345678

Product tier billing plan ID

Responses

Response samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "id": "bp-12345678",
  • "maxNumberofInstances": 5,
  • "planName": "STARTER",
  • "pricing": {
    },
  • "productTierId": "pt-12345678",
  • "serviceId": "s-12345678"
}

UpdateProductTierBillingPlan product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

id
required
string^(?P<entitytype>bp)-(?P<entityid>[a-zA-Z0-9][...
Example: bp-12345678

Product tier billing plan ID

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
boolean

Allow creates when payment not configured

maxNumberofInstances
integer <int64>

Maximum number of instances

planName
string

Plan name

pricing
string <binary>

Pricing in dollars.

Responses

Request samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "maxNumberofInstances": 5,
  • "planName": "STARTER",
  • "pricing": {
    }
}

Response samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "id": "bp-12345678",
  • "maxNumberofInstances": 5,
  • "planName": "STARTER",
  • "pricing": {
    },
  • "productTierId": "pt-12345678",
  • "serviceId": "s-12345678"
}

CopyProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

sourceId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

The source product tier ID

Request Body schema: application/json
required
awsRegions
Array of strings

The AWS regions that this product tier is available on

description
required
string

A brief description of the product tier

documentation
string

Documentation

gcpRegions
Array of strings

The GCP regions that this product tier is available on

name
required
string

Name of the product tier

planDescription
string

A brief description for the end user of the product tier

pricing
string <binary>

Pricing

serviceModelId
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...

Service model ID

support
string

Support

targetTierType
string
Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY"

Tier type

Responses

Request samples

Content type
application/json
{
  • "awsRegions": [
    ],
  • "description": "A premium product tier",
  • "documentation": "Any documentation",
  • "gcpRegions": [
    ],
  • "name": "Premium",
  • "planDescription": "A premium plan",
  • "pricing": {
    },
  • "serviceModelId": "sm-12345678",
  • "support": "Any support",
  • "targetTierType": "OMNISTRATE_DEDICATED_TENANCY"
}

Response samples

Content type
application/json
"pt-12345678"

service-api-api

CreateServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

Request Body schema: application/json
required
description
required
string

A brief description of the service API bundle

serviceEnvironmentId
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...

The service environment ID

Responses

Request samples

Content type
application/json
{
  • "description": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
  • "serviceEnvironmentId": "se-12345678"
}

Response samples

Content type
application/json
"sa-12345678"

DeleteServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...
Example: sa-12345678

The service API ID

Responses

DescribeServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...
Example: sa-12345678

The service API ID

Responses

Response samples

Content type
application/json
{
  • "apiVersion": "v1",
  • "deploymentConfigId": "dc-12345678",
  • "description": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
  • "id": "sa-12345678",
  • "serviceEnvironmentId": "se-12345678",
  • "serviceId": "s-12345678",
  • "serviceName": "mysql"
}

UpdateServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...
Example: sa-12345678

The service API ID

Request Body schema: application/json
required
description
string

A brief description of the service API bundle

Responses

Request samples

Content type
application/json
{
  • "description": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability"
}

DiscardPendingChanges service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...
Example: sa-12345678

The service API ID

query Parameters
productTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: productTierId=pt-12345678

ProductTierID of the resource to describe pending changes forNeeds to specified in combination with the product tier version

Responses

DescribePendingChanges service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...
Example: sa-12345678

The service API ID

query Parameters
productTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: productTierId=pt-12345678

ProductTierID of the resource to describe pending changes forNeeds to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "id": "sa-12345678",
  • "resourceChangeSets": {
    },
  • "serviceId": "s-12345678"
}

DeprecateServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...
Example: sa-12345678

The service API ID

Responses

ReleaseServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][...
Example: sa-12345678

The service API ID

Request Body schema: application/json
required
isPreferred
boolean
Default: false

Indicates whether this version set is preferred.

productTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...

The product tier ID

versionSetName
string

The name of the version set to release

versionSetType
string
Enum: "Major" "Incremental" "UserDefined"

The version-set type of the product-tier.

Responses

Request samples

Content type
application/json
{
  • "isPreferred": true,
  • "productTierId": "pt-12345678",
  • "versionSetName": "v1",
  • "versionSetType": "Major"
}

ListServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

serviceEnvironmentId
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

The service environment ID

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

service-plan-api

ListServicePlans service-plan-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

serviceEnvironmentId
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

Service environment ID

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "next-token",
  • "servicePlans": [
    ]
}

GetServicePlan service-plan-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

Product tier ID

Responses

Response samples

Content type
application/json
{
  • "AutoApproveSubscription": false,
  • "accountConfigIds": [
    ],
  • "activeAccountConfigIds": {
    },
  • "apiVersion": "v1",
  • "awsRegions": [
    ],
  • "deploymentConfigId": "dc-12345678",
  • "gcpRegions": [
    ],
  • "hasPendingChanges": true,
  • "isProductTierDisabled": true,
  • "latestMajorVersion": "3.0",
  • "modelType": "CUSTOMER_HOSTED",
  • "productTierDescription": "A premium product tier",
  • "productTierDocumentation": "Any documentation",
  • "productTierFeatures": {
    },
  • "productTierId": "pt-12345678",
  • "productTierKey": "premium",
  • "productTierName": "Premium",
  • "productTierPlanDescription": "A premium plan",
  • "productTierPricing": {
    },
  • "productTierSupport": "Any support",
  • "serviceApiDescription": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
  • "serviceApiId": "sa-12345678",
  • "serviceEnvironmentId": "se-12345678",
  • "serviceModelDescription": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
  • "serviceModelId": "sm-12345678",
  • "serviceModelName": "MySQL multi-writer service hosted model",
  • "tierType": "OMNISTRATE_DEDICATED_TENANCY",
  • "versionSetStatus": "Active"
}

resource-api

ListResources resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: si-12345678

The ID of the service to list resources for

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: pt-12345678

The product tier ID

query Parameters
managed
boolean
Example: managed=false

Is resource managed by omnistrate

ProductTierVersion
string
Example: ProductTierVersion=Cupiditate maiores dolore voluptate modi eum consectetur.

Product tier version of the instance to describe. If not specified, the latest version is described.

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token",
  • "resources": [
    ]
}

CreateResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

Request Body schema: application/json
required
description
required
string

A brief description of the resource

Array of objects (EnvironmentVariable)

The environment variables that this resource requires

imageConfigId
string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9...

The ID of the image configuration that this resource refers to

infraConfigId
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...

The ID of the infrastructure configuration that this resource refers to

internal
boolean
Default: false

Whether this resource is internal or not

isProxy
boolean
Default: false

Whether this resource is a proxy or not

key
string

The key of the resource

object (L4LoadBalancerConfiguration)
object (L7LoadBalancerConfiguration)
name
required
string

Name of the resource

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...

The product tier ID

proxyType
string
Default: "PortsBasedProxy"
Value: "PortsBasedProxy"

A proxy type of resource

Array of objects (ResourceDependency)
resourceType
string
Enum: "" "Generic" "L7LoadBalancer" "L4LoadBalancer"

The type of the resource

Responses

Request samples

Content type
application/json
{
  • "description": "A resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
  • "environmentVariables": [
    ],
  • "imageConfigId": "imgc-12345678",
  • "infraConfigId": "ic-12345678",
  • "internal": false,
  • "isProxy": false,
  • "key": "galera",
  • "l4LoadBalancerConfiguration": {
    },
  • "l7LoadBalancerConfiguration": {
    },
  • "name": "Galera",
  • "productTierId": "pt-12345678",
  • "proxyType": "PortsBasedProxy",
  • "resourceDependencies": [
    ],
  • "resourceType": "Generic"
}

Response samples

Content type
application/json
"r-12345678"

DeleteResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Responses

DescribeResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Tempore ut eaque reiciendis sunt in non.

Product tier version of the resource to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the resource to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "actionHooks": [
    ],
  • "capabilities": [
    ],
  • "dependencies": [
    ],
  • "description": "An resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
  • "environmentVariables": [
    ],
  • "id": "r-12345678",
  • "imageConfigId": "imgc-12345678",
  • "infraConfigId": "ic-12345678",
  • "internal": false,
  • "isDeprecated": true,
  • "key": "galera",
  • "l4LoadBalancerConfiguration": {
    },
  • "l7LoadBalancerConfiguration": {
    },
  • "name": "Galera",
  • "productTierId": "pt-12345678",
  • "proxyType": "PortsBasedProxy",
  • "resourceType": "Generic",
  • "serviceId": "s-12345678"
}

UpdateResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
Array of objects (ResourceDependency)
description
string

A brief description of the resource

Array of objects (EnvironmentVariable)

The environment variables that this resource requires

imageConfigId
string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9...

The ID of the image configuration that this resource refers to

infraConfigId
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...

The ID of the infrastructure configuration that this resource refers to

object (L4LoadBalancerConfiguration)
object (L7LoadBalancerConfiguration)
name
string

Name of the resource

Responses

Request samples

Content type
application/json
{
  • "dependencies": [
    ],
  • "description": "A resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
  • "environmentVariables": [
    ],
  • "imageConfigId": "imgc-12345678",
  • "infraConfigId": "ic-12345678",
  • "l4LoadBalancerConfiguration": {
    },
  • "l7LoadBalancerConfiguration": {
    },
  • "name": "Galera"
}

DeregisterActionHook resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service to which the hook belongs

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource to which the hook belongs

Request Body schema: application/json
required
scope
required
string
Enum: "CLUSTER" "NODE"

The scope of the hook

type
required
string
Enum: "INIT" "ADD" "REMOVE" "PROMOTE" "DEMOTE" "HEALTH_CHECK" "POST_START" "POST_UPGRADE" "PRE_STOP"

The type of hook to execute

Responses

Request samples

Content type
application/json
{
  • "scope": "CLUSTER",
  • "type": "ADD"
}

ListActionHooks resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service to which the hook belongs

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource to which the hook belongs

Responses

Response samples

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

RegisterActionHook resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service to which the hook belongs

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource to which the hook belongs

Request Body schema: application/json
required
commandTemplate
required
string

The Base64 encoded command template to execute

scope
required
string
Enum: "CLUSTER" "NODE"

The scope of the hook

type
required
string
Enum: "INIT" "ADD" "REMOVE" "PROMOTE" "DEMOTE" "HEALTH_CHECK" "POST_START" "POST_UPGRADE" "PRE_STOP"

The type of hook to execute

Responses

Request samples

Content type
application/json
{
  • "commandTemplate": "ZWNobyAiaGVsbG8gd29ybGQi",
  • "scope": "CLUSTER",
  • "type": "ADD"
}

DisableResourceCapability resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
capability
required
string
Enum: "SERVERLESS" "SERVICE_ACCOUNT_POLICIES" "PROCESS_CORE_DUMP"

The capability to disable

Responses

Request samples

Content type
application/json
{
  • "capability": "SERVERLESS"
}

ListResourceCapabilities resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Amet ad et ipsa facilis cupiditate molestias.

Product tier version of the instance to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

Product tier id of the instance to describe. Needs to specified in combination with the product tier version

Responses

Response samples

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

EnableResourceCapability resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
capability
required
string
Enum: "SERVERLESS" "SERVICE_ACCOUNT_POLICIES" "PROCESS_CORE_DUMP"

The type of capability of a resource

object

The configuration parameters of a capability of a resource

Responses

Request samples

Content type
application/json
{
  • "capability": "SERVERLESS",
  • "configuration": {
    }
}

ListDependentResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Responses

Response samples

Content type
application/json
{
  • "id": "r-12345678",
  • "ids": [
    ],
  • "nextPageToken": "next-token",
  • "serviceId": "s-12345678"
}

DeprecateResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Responses

UnsetEnvironmentVariables resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
Array of objects (EnvironmentVariable)

The environment variables that this resource requires

Responses

Request samples

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

SetEnvironmentVariables resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
Array of objects (EnvironmentVariable)

The environment variables that this resource requires

Responses

Request samples

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

DeregisterResourceMetricsConfig resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Responses

DescribeResourceMetricsConfig resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Quod et voluptatibus quia aut eius quia.

Product tier version of the resource to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the resource to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{}

RegisterResourceMetricsConfig resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
metricEndpoint
required
string

The local host endpoint to supply prometheus metric

Responses

Request samples

Content type
application/json
{}

RemoveResourceDependency resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

resourceDependencyId
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource dependency to remove

Responses

AddResourceDependency resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource

resourceDependencyId
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource to be added as a dependency

Request Body schema: application/json
required
object

A map of the source parameter to the dependency resource parameter

Responses

Request samples

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

tier-version-set-api

ListTierVersionSets tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

ID of the Service

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: Nostrum deserunt.

The product tier ID that this version set belongs to.

query Parameters
latestMajorVersionOnly
boolean
Example: latestMajorVersionOnly=true

If true, the latest major version is returned. The parameter needs to be specified in isolation.

latestIncrementalVersionForMajorVersion
string
Example: latestIncrementalVersionForMajorVersion=3.0

Returns the latest incremental version for the given major version. The paramenter needs to be specified in isolation.

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "next-token",
  • "tierVersionSets": [
    ]
}

CreateTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

ID of the Service

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: Nostrum deserunt.

The product tier ID that this version set belongs to.

Request Body schema: application/json
required
description
string

A brief description of the product-tier version set.

name
string

The name of the product-tier version set.

parentVersion
string

The parent version of this version set.

type
required
string
Enum: "Major" "Incremental" "UserDefined"

The version-set type of the product-tier.

Responses

Request samples

Content type
application/json
{
  • "description": "Et sit vel nesciunt et numquam eveniet.",
  • "name": "Major version set",
  • "parentVersion": "2.0",
  • "type": "Major"
}

Response samples

Content type
application/json
{
  • "version": "3.0"
}

DescribeTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

ID of the Service

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: Nostrum deserunt.

The product tier ID that this version set belongs to.

version
required
string
Example: 3.0

The version number for the specific version set.

Responses

Response samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "baseVersion": "3.0",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "description": "Sunt corporis dolor eveniet.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "upgrade-12345678",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Dewitt Steuber",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-12345678",
  • "serviceModelId": "Diana Schmeler",
  • "status": "Active",
  • "type": "Major",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

DeprecateTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

ID of the Service

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: Nostrum deserunt.

The product tier ID that this version set belongs to.

version
required
string
Example: 3.0

The version number for the specific version set.

Responses

Response samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "baseVersion": "3.0",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "description": "Ab totam iusto.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "upgrade-12345678",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Myrtis Stoltenberg",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-12345678",
  • "serviceModelId": "Rosalee Weimann",
  • "status": "Active",
  • "type": "Major",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

DiffTierVersionSets tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

ID of the Service

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: Nostrum deserunt.

The product tier ID that this version set belongs to.

version
required
string
Example: 3.0

The version number for the version set.

anotherVersion
required
string
Example: 3.1

The target version to compare against.

Responses

Response samples

Content type
application/json
{
  • "anotherVersion": "3.1",
  • "productTierId": "Crystel Dicki",
  • "resourceChangeSets": {
    },
  • "serviceId": "s-12345678",
  • "version": "3.0"
}

PromoteTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

ID of the Service

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: Nostrum deserunt.

The product tier ID that this version set belongs to.

version
required
string
Example: 3.0

The version number for the specific version set.

Responses

Response samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "baseVersion": "3.0",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "description": "Vel nemo saepe.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "upgrade-12345678",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Lupe Swaniawski",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-12345678",
  • "serviceModelId": "Justice Bechtelar PhD",
  • "status": "Active",
  • "type": "Major",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

ReleaseTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

ID of the Service

productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: Nostrum deserunt.

The product tier ID that this version set belongs to.

version
required
string
Example: 3.0

The version number for the specific version set.

Request Body schema: application/json
required
isPreferred
boolean

Indicates whether this version set is preferred.

name
string

The name of the product-tier version set.

Responses

Request samples

Content type
application/json
{
  • "isPreferred": true,
  • "name": "Major version set"
}

Response samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "baseVersion": "3.0",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "description": "Ut id iusto laudantium.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "upgrade-12345678",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Brianne Cummings",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-12345678",
  • "serviceModelId": "Destiny Hackett",
  • "status": "Active",
  • "type": "Major",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

input-parameter-api

CreateInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

Request Body schema: application/json
required
defaultValue
string

Default value to use for an optional input parameter represented as a string

dependentResourceId
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...

The ID of the resource whose instance this input parameter depends on

description
required
string

A brief description of the input parameter

hasOptions
boolean
Default: false

Marks the input parameter to be selectable from a list of values

isList
boolean
Default: false

Marks the input parameter as a list of values

key
required
string non-empty ^[a-zA-Z][a-zA-Z0-9_]*$

Key of the input parameter

object (Limits)

Limit of a parameter

modifiable
required
boolean

Marks the input parameter as immutable

name
required
string non-empty

External name for the input parameter

options
Array of strings

A list of options to restrict the value of the input parameter to (represented as a string)

required
required
boolean

Enforces the input parameter as a required parameter

resourceId
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...

The ID of the resource that this input parameter belongs to

type
required
string
Enum: "Boolean" "Float64" "String" "Resource" "Secret" "Password"

Responses

Request samples

Content type
application/json
{
  • "defaultValue": "default value",
  • "dependentResourceId": "r-12345678",
  • "description": "Quaerat ad aperiam.",
  • "hasOptions": false,
  • "isList": true,
  • "key": "rjr",
  • "limits": {
    },
  • "modifiable": true,
  • "name": "a77",
  • "options": [
    ],
  • "required": false,
  • "resourceId": "r-12345678",
  • "type": "Password"
}

Response samples

Content type
application/json
"ip-12345678"

DeleteInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string^(?P<entitytype>ip)-(?P<entityid>[a-zA-Z0-9][...
Example: var-12345678

ID of the input parameter

Responses

DescribeInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string^(?P<entitytype>ip)-(?P<entityid>[a-zA-Z0-9][...
Example: var-12345678

ID of the input parameter

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Ipsam minus ratione rerum quia.

Product tier version of the instance to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

Product tier id of the instance to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "defaultValue": "true",
  • "dependentResourceId": "r-12345678",
  • "description": "Modi et et.",
  • "hasOptions": true,
  • "id": "var-12345678",
  • "isList": true,
  • "key": "w",
  • "limits": {
    },
  • "modifiable": true,
  • "name": "ep",
  • "options": [
    ],
  • "required": false,
  • "resourceId": "r-12345678",
  • "serviceId": "s-12345678",
  • "type": "String"
}

UpdateInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string^(?P<entitytype>ip)-(?P<entityid>[a-zA-Z0-9][...
Example: var-12345678

ID of the input parameter

Request Body schema: application/json
required
defaultValue
string

Default value to use for an optional input parameter represented as a string

description
string

A brief description of the input parameter

hasOptions
boolean

Marks the input parameter to be selectable from a list of values

object (Limits)

Limit of a parameter

modifiable
boolean

Marks the input parameter as immutable

name
string non-empty

External name for the input parameter

options
Array of strings

A list of options to restrict the value of the input parameter to (represented as a string)

required
boolean

Enforces the input parameter as a required parameter

Responses

Request samples

Content type
application/json
{
  • "defaultValue": "[\"1\", \"2.8\", \"3\"]",
  • "description": "Et inventore.",
  • "hasOptions": false,
  • "limits": {
    },
  • "modifiable": false,
  • "name": "xv",
  • "options": [
    ],
  • "required": false
}

ListInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

resourceId
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource that this input parameter belongs to

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Dolor alias in.

Product tier version of the instance to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

Product tier id of the instance to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "inputParameters": [
    ],
  • "nextPageToken": "next-token"
}

output-parameter-api

CreateOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

Request Body schema: application/json
required
description
required
string non-empty

Description of the output variable being exported

key
required
string non-empty ^[a-zA-Z][a-zA-Z0-9_]*$

Key of the output variable being exported

name
required
string non-empty

External name of the output variable being exported

resourceId
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...

The ID of the resource that this output parameter belongs to

value
string

Value of the output variable being exported

valueRef
string

Reference to another variable that will be used to set the value of the output variable being exported

valueType
string
Enum: "Boolean" "Float64" "String" "Secret" "Password"

Responses

Request samples

Content type
application/json
{
  • "description": "Username of the user created in the target system",
  • "key": "username",
  • "name": "Username",
  • "resourceId": "r-12345678",
  • "value": "johndoe",
  • "valueRef": "$var.username",
  • "valueType": "Boolean"
}

Response samples

Content type
application/json
"op-12345678"

DeleteOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string^(?P<entitytype>op)-(?P<entityid>[a-zA-Z0-9][...
Example: op-12345678

The ID of the output parameter

Responses

DescribeOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string^(?P<entitytype>op)-(?P<entityid>[a-zA-Z0-9][...
Example: op-12345678

The ID of the output parameter

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Et non cupiditate.

Product tier version of the resource to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the resource to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "description": "Username of the user created in the target system",
  • "id": "op-12345678",
  • "key": "username",
  • "name": "Username",
  • "resourceId": "r-12345678",
  • "serviceId": "s-12345678",
  • "value": "johndoe",
  • "valueRef": "$var.username",
  • "valueType": "Boolean"
}

UpdateOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string^(?P<entitytype>op)-(?P<entityid>[a-zA-Z0-9][...
Example: op-12345678

The ID of the output parameter

Request Body schema: application/json
required
description
string non-empty

Description of the output variable being exported

name
string non-empty

External name of the output variable being exported

value
string non-empty

Value of the output variable being exported

valueRef
string

Reference to an input variable that will be used to set the value of the output variable being exported

valueType
string
Enum: "Boolean" "Float64" "String" "Secret" "Password"

Responses

Request samples

Content type
application/json
{
  • "description": "Username of the user created in the target system",
  • "name": "Username",
  • "value": "johndoe",
  • "valueRef": "$var.username",
  • "valueType": "Secret"
}

ListOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service that this output parameter belongs to

resourceId
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The ID of the resource that this output parameter belongs to

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Harum saepe aliquid et modi molestiae voluptates.

Product tier version of the resource to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the resource to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token",
  • "outputParameters": [
    ]
}

vunit-api

The external facing VUnit API

ListVUnits vunit-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID for the VUnit

serviceModelId
required
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: sm-12345678

Service Model ID for the VUnit

Request Body schema: application/json
required
cloudProvider
required
string
Enum: "aws" "azure" "gcp" "all"

The infra / cloud provider name

region
required
string

Region code specific to the cloud-provider

Responses

Request samples

Content type
application/json
{
  • "cloudProvider": "aws",
  • "region": "us-west-2"
}

Response samples

Content type
application/json
{
  • "ids": {
    },
  • "nextPageToken": "next-token"
}

DescribeNetwork vunit-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID context

id
required
string^(?P<entitytype>n)-(?P<entityid>[a-zA-Z0-9][a...
Example: n-12345678

Network to operate on

Responses

Response samples

Content type
application/json
{
  • "cidr": "10.0.0.0/16",
  • "id": "n-12345678",
  • "networkConfigId": "nc-12345678",
  • "serviceId": "s-12345678",
  • "type": "PUBLIC",
  • "vunitId": "vu-12345678"
}

DescribeVUnit vunit-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

Service ID for the VUnit

id
required
string^(?P<entitytype>vu)-(?P<entityid>[a-zA-Z0-9][...
Example: vu-12345678

VUnit to operate on

Responses

Response samples

Content type
application/json
{
  • "cloudProvider": "aws",
  • "id": "vu-12345678",
  • "networkIds": [
    ],
  • "region": "us-west-2",
  • "serviceId": "s-12345678",
  • "serviceModelId": "sm-12345678"
}

infra-config-api

The infra config API manages the infra for Omnistrate resources

CreateInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

Request Body schema: application/json
required
computeConfigId
string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][...

The compute config ID

object (EnvironmentVariable)

A service environment variable

description
required
string

The description for the infra config

name
required
string

The name of the infra config

networkConfigId
string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][...

The network config ID

serviceEnvironmentId
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...

The service environment ID

storageConfigId
string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][...

The storage config ID

Responses

Request samples

Content type
application/json
{
  • "computeConfigId": "cc-12345678",
  • "customTag": {
    },
  • "description": "Infra config used for the base tier MySQL service",
  • "name": "MySQL Writer Infra Config",
  • "networkConfigId": "nc-12345678",
  • "serviceEnvironmentId": "se-12345678",
  • "storageConfigId": "sc-12345678"
}

Response samples

Content type
application/json
"ic-12345678"

DeleteInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Responses

DescribeInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Non atque commodi delectus assumenda magnam.

Product tier version of the infra config to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the infra config to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "computeConfigId": "cc-12345678",
  • "customTag": {
    },
  • "description": "Infra config used for the base tier MySQL service",
  • "id": "ic-12345678",
  • "name": "MySQL Writer Infra Config",
  • "networkConfigId": "nc-12345678",
  • "serviceEnvironmentId": "se-12345678",
  • "serviceId": "s-12345678",
  • "storageConfigId": "sc-12345678"
}

UpdateInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Request Body schema: application/json
required
computeConfigId
string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][...

The compute config ID

object (EnvironmentVariable)

A service environment variable

description
string

The description for the infra config

name
string

The name of the infra config

networkConfigId
string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][...

The network config ID

storageConfigId
string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][...

The storage config ID per compute node

Responses

Request samples

Content type
application/json
{
  • "computeConfigId": "cc-12345678",
  • "customTag": {
    },
  • "description": "Infra config used for the base tier MySQL service",
  • "name": "MySQL Writer Infra Config",
  • "networkConfigId": "nc-12345678",
  • "storageConfigId": "sc-12345678"
}

ListAssociatedResources infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Responses

Response samples

Content type
application/json
{
  • "id": "ic-12345678",
  • "resourceIds": [
    ],
  • "serviceId": "s-12345678"
}

DetachComputeConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Responses

DetachNetworkConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Responses

ReleaseInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Request Body schema: application/json
required
productTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...

The product tier ID

Responses

Request samples

Content type
application/json
{
  • "productTierId": "pt-12345678"
}

RolloutFleetInfra infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Responses

RolloutFleetInfraStatus infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Responses

Response samples

Content type
application/json
{
  • "status": "IN_PROGRESS"
}

DetachStorageConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][...
Example: ic-12345678

Infra Config ID to operate on

Responses

ListInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

serviceEnvironmentId
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

The service environment ID

query Parameters
managed
boolean
Example: managed=false

Is infra config managed by omnistrate

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

image-config-api

The image config API manages the image config for Omnistrate entities

CreateImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID to use for the infra

Request Body schema: application/json
required
object (CustomImageCommandsAndArgs)

Commands and arguments to run in the container

description
required
string

A brief description of the image configuration

imageName
required
string non-empty

Name of the container image

imageRegistryId
string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][...

The image registry ID to use for the infra

imageSignaturePublicKeyPEM
string

PEM-encoded Public key part of the key used to sign the container image

imageTag
string
Default: "latest"

Tag representing the specific software image version

serviceEnvironmentId
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...

The service environment ID

Responses

Request samples

Content type
application/json
{
  • "customImageCommandsAndArgs": {
    },
  • "description": "A image configuration for my new entity",
  • "imageName": "mysql",
  • "imageRegistryId": "ir-12345678",
  • "imageSignaturePublicKeyPEM": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
  • "imageTag": "latest",
  • "serviceEnvironmentId": "se-12345678"
}

Response samples

Content type
application/json
"imgc-12345678"

DeleteImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9...
Example: imgc-12345678

The image configuration ID

Responses

DescribeImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9...
Example: imgc-12345678

The image configuration ID

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Dicta assumenda cum.

Product tier version of the image config to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the image config to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "customImageCommandsAndArgs": {
    },
  • "description": "An image configuration for my new entity",
  • "id": "imgc-12345678",
  • "imageName": "mysql",
  • "imageRegistryId": "ir-12345678",
  • "imageSignaturePublicKeyPEM": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
  • "imageTag": "v1",
  • "serviceEnvironmentId": "se-12345678",
  • "serviceId": "s-12345678"
}

UpdateImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9...
Example: imgc-12345678

The image configuration ID

Request Body schema: application/json
required
object (CustomImageCommandsAndArgs)

Commands and arguments to run in the container

description
string

A brief description of the image configuration

imageName
string non-empty

Name of the container image

imageRegistryId
string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][...

The image registry ID to use for the infra

imageSignaturePublicKeyPEM
string

PEM-encoded Public key part of the key used to sign the container image

imageTag
string

Tag representing the software image version that is currently preferred

Responses

Request samples

Content type
application/json
{
  • "customImageCommandsAndArgs": {
    },
  • "description": "An image configuration for my new entity",
  • "imageName": "mysql",
  • "imageRegistryId": "ir-12345678",
  • "imageSignaturePublicKeyPEM": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
  • "imageTag": "v1"
}

ReleaseImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9...
Example: imgc-12345678

The image configuration ID

Request Body schema: application/json
required
productTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...

The product tier ID

Responses

Request samples

Content type
application/json
{
  • "productTierId": "pt-12345678"
}

RolloutFleetImageStatus image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9...
Example: imgc-12345678

The image configuration ID

Responses

Response samples

Content type
application/json
{
  • "status": "IN_PROGRESS"
}

RolloutFleetImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9...
Example: imgc-12345678

The image configuration ID

Responses

ListImageConfigs image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID to use for the infra

serviceEnvironmentId
required
string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][...
Example: se-12345678

The service environment ID

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

deployment-config-api

The deployment config API manages the deployment config for Omnistrate entities

ListDeploymentConfigs deployment-config-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateDeploymentConfig deployment-config-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
description
required
string

A brief description of the deployment config

object (InfraRollConfiguration)

The rollout configuration to use for making changes to the resources backed by this infra

name
required
string

Name of the deployment config

rolloutPriorityList
Array of strings[^(?P<entitytype>region)-(?P<entityid>[a-zA-Z0...]

Responses

Request samples

Content type
application/json
{
  • "description": "A production deployment config",
  • "infraRollConfiguration": {
    },
  • "name": "Production",
  • "rolloutPriorityList": [
    ]
}

Response samples

Content type
application/json
"dc-12345678"

DeleteDeploymentConfig deployment-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>dc)-(?P<entityid>[a-zA-Z0-9][...
Example: dc-12345678

The deployment configuration ID

Responses

DescribeDeploymentConfig deployment-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Examples:
  • default - default

The deployment configuration ID

Responses

Response samples

Content type
application/json
{
  • "description": "A production deployment config",
  • "id": "dc-12345678",
  • "infraRollConfiguration": {
    },
  • "name": "Production",
  • "rolloutPriorityList": [
    ]
}

UpdateDeploymentConfig deployment-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>dc)-(?P<entityid>[a-zA-Z0-9][...
Example: dc-12345678

The deployment configuration ID

Request Body schema: application/json
required
description
string

A brief description of the deployment config

object (InfraRollConfiguration)

The rollout configuration to use for making changes to the resources backed by this infra

name
string

Name of the deployment config

rolloutPriorityList
Array of strings[^(?P<entitytype>region)-(?P<entityid>[a-zA-Z0...]

Responses

Request samples

Content type
application/json
{
  • "description": "A production deployment config",
  • "infraRollConfiguration": {
    },
  • "name": "Production",
  • "rolloutPriorityList": [
    ]
}

compute-config-api

The compute config API manages the compute config for Omnistrate entities

ListComputeConfig compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

query Parameters
managed
boolean
Example: managed=false

Is compute config managed by omnistrate

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateComputeConfig compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

Request Body schema: application/json
required
object (AutoscalingPolicy)

Autoscaling policy for compute nodes

description
required
string non-empty

Description of the compute config

name
required
string non-empty

Name of the compute config

replicaCount
string

Number of replicas to provision for this logical pool of nodes per instance of the resource

object (ResourceSpec)

Resource requirements

rootVolumeSizeGi
integer <int64>

Size of the root volume in Gi

object (WarmPoolConfiguration)

Warm pool configuration for compute nodes

Responses

Request samples

Content type
application/json
{
  • "autoscalingPolicy": {
    },
  • "description": "my compute config description",
  • "name": "my compute config",
  • "replicaCount": "3",
  • "resources": {
    },
  • "rootVolumeSizeGi": 10,
  • "warmPoolConfiguration": {
    }
}

Response samples

Content type
application/json
"cc-12345678"

DeleteComputeConfig compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][...
Example: cc-12345678

ID of the compute config

Responses

DescribeComputeConfig compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][...
Example: cc-12345678

ID of the compute config

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Eaque consequatur cumque magni sint.

Product tier version of the compute config to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the compute config to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "autoscalingPolicy": {
    },
  • "description": "my compute config description",
  • "id": "cc-12345678",
  • "infraConfigIDs": [
    ],
  • "instanceTypes": {
    },
  • "name": "my compute config",
  • "replicaCount": "3",
  • "resources": {
    },
  • "rootVolumeSizeGi": 10,
  • "serviceId": "s-12345678",
  • "warmPoolConfiguration": {
    }
}

UpdateComputeConfig compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][...
Example: cc-12345678

ID of the compute config

Request Body schema: application/json
required
object (AutoscalingPolicy)

Autoscaling policy for compute nodes

description
string non-empty

Description of the compute config

name
string non-empty

Name of the compute config

replicaCount
string

Number of replicas to provision for this logical pool of nodes per instance of the resource

object (ResourceSpec)

Resource requirements

rootVolumeSizeGi
integer <int64>

Size of the root volume in Gi

object (WarmPoolConfiguration)

Warm pool configuration for compute nodes

Responses

Request samples

Content type
application/json
{
  • "autoscalingPolicy": {
    },
  • "description": "my compute config description",
  • "name": "my compute config",
  • "replicaCount": "3",
  • "resources": {
    },
  • "rootVolumeSizeGi": 10,
  • "warmPoolConfiguration": {
    }
}

RemoveComputeInstanceType compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][...
Example: cc-12345678

ID of the compute config

Request Body schema: application/json
required
cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"

The cloud provider for this compute instance type config

instanceType
required
string

The instance type for this compute instance type config

Responses

Request samples

Content type
application/json
{
  • "cloudProviderName": "aws",
  • "instanceType": "t3.micro"
}

AddComputeInstanceType compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][...
Example: cc-12345678

ID of the compute config

Request Body schema: application/json
required
cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"

The cloud provider for this compute instance type config

instanceType
required
string

The instance type for this compute instance type config

Responses

Request samples

Content type
application/json
{
  • "cloudProviderName": "aws",
  • "instanceType": "t3.micro"
}

ListComputeInstanceTypes compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"
Example: aws

The cloud provider for this compute instance type config

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "next-token",
  • "types": [
    ]
}

storage-config-api

The storage config API manages the storage config for Omnistrate entities

ListStorageConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service id to filter by

query Parameters
managed
boolean
Example: managed=false

Is storage config managed by omnistrate

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateStorageConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service to which this storage config belongs

Request Body schema: application/json
required
description
required
string non-empty

Description of the storage config

name
required
string non-empty

Name of the storage config

Responses

Request samples

Content type
application/json
{
  • "description": "my-storage-config-description",
  • "name": "my-storage-config"
}

Response samples

Content type
application/json
"sc-12345678"

DeleteStorageConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][...
Example: sc-12345678

The storage config ID

Responses

DescribeStorageConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][...
Example: sc-12345678

The storage config ID

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Explicabo rem nihil veniam nam dolorum.

Product tier version of the storage config to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the storage config to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "description": "my-storage-config-description",
  • "id": "sc-12345678",
  • "infraConfigIDs": [
    ],
  • "name": "my-storage-config",
  • "serviceId": "s-12345678",
  • "volumes": {
    }
}

UpdateStorageConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][...
Example: sc-12345678

The storage config ID

Request Body schema: application/json
required
description
string

A brief description of the service model

name
string

Name of the Service Model

Responses

Request samples

Content type
application/json
{
  • "description": "my-storage-config-description",
  • "name": "my-storage-config"
}

RemoveStorageVolumeConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][...
Example: sc-12345678

The storage config ID

storageVolumeConfigId
required
string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]...
Example: svc-12345678

The storage volume config ID

Request Body schema: application/json
required
mountPath
string

The path where the storage volume will be mounted

Responses

Request samples

Content type
application/json
{
  • "mountPath": "/data"
}

AddStorageVolumeConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][...
Example: sc-12345678

The storage config ID

storageVolumeConfigId
required
string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]...
Example: svc-12345678

The storage volume config ID

Request Body schema: application/json
required
mountPath
string

The path where the storage volume will be mounted

Responses

Request samples

Content type
application/json
{
  • "mountPath": "/data"
}

storage-volume-config-api

The storage volume config API manages the storage volume config for Omnistrate entities

ListStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service to list storage volume configs for

query Parameters
managed
boolean
Example: managed=false

Is storage volume config managed by omnistrate

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

Request Body schema: application/json
required
clusterStorageType
string

The type of the fixed storage for the cluster

description
required
string

A brief description of the context for the storage volume pool

instanceStorageIops
string

The IOPS provisioned for the configured instance storage type

instanceStorageSizeGi
string

The storage size (in Gi) provisioned for the configured instance storage type

instanceStorageThroughputMiBps
string

The throughput (in MiBps) provisioned for the configured instance storage type

instanceStorageType
string

The type of the storage for a compute instance

name
required
string

Name of the storage volume pool

Responses

Request samples

Content type
application/json
{
  • "clusterStorageType": "$var.storageType",
  • "description": "A storage volume set to store the MySQL data directory",
  • "instanceStorageIops": "$var.storageIops",
  • "instanceStorageSizeGi": "$var.storage_size",
  • "instanceStorageThroughputMiBps": "128",
  • "instanceStorageType": "$var.storageType",
  • "name": "MySQL Data Volume"
}

Response samples

Content type
application/json
"svc-12345678"

DeleteStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]...
Example: svc-12345678

The storage volume config ID

Responses

DescribeStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]...
Example: svc-12345678

The storage volume config ID

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Minus earum facere.

Product tier version of the network config to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the network config to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "cloudProviderName": "aws",
  • "clusterStorageType": "$var.storageType",
  • "description": "A storage volume set to store the MySQL data directory",
  • "id": "svc-12345678",
  • "instanceStorageIops": "7500",
  • "instanceStorageSizeGi": "128",
  • "instanceStorageThroughputMiBps": "128",
  • "instanceStorageType": "$var.storageType",
  • "name": "MySQL Data Volume",
  • "serviceId": "s-12345678"
}

UpdateStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]...
Example: svc-12345678

The storage volume config ID

Request Body schema: application/json
required
description
string

A brief description of the service model

name
string

Name of the Service Model

Responses

Request samples

Content type
application/json
{
  • "description": "A storage volume set to store the MySQL data directory",
  • "name": "MySQL Data Volume"
}

UpdateInstanceStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]...
Example: svc-12345678

The storage volume config ID

Request Body schema: application/json
required
instanceStorageIops
string

The IOPS provisioned for the configured instance storage type

instanceStorageThroughputMiBps
string

The throughput (in MiBps) provisioned for the configured instance storage type

instanceStorageType
string

The type of the storage for a compute instance

Responses

Request samples

Content type
application/json
{
  • "instanceStorageIops": "7500",
  • "instanceStorageThroughputMiBps": "128",
  • "instanceStorageType": "AWS::EBS_GP2"
}

UpdateStorageVolumeSizeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

id
required
string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]...
Example: svc-12345678

The storage volume config ID

Request Body schema: application/json
required
instanceStorageSizeGi
required
string

The storage size (in Gi) provisioned for the configured instance storage type

Responses

Request samples

Content type
application/json
{
  • "instanceStorageSizeGi": "$var.storage_size"
}

network-config-api

The network config API manages the network config for Omnistrate entities

ListNetworkConfig network-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID to list network configs for

query Parameters
managed
boolean
Example: managed=false

Is network config managed by omnistrate

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "token"
}

CreateNetworkConfig network-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service

Request Body schema: application/json
required
description
required
string

A brief description of the network config

endpointPerReplica
required
boolean

Generates a DNS endpoint per-replica for this network config

internal
boolean
Default: false

Restrict access to this network config to the internal network

name
required
string

Name of the network config

openPorts
Array of integers <int64> [ items <int64 > ]

Ports to map to the generated DNS endpoint

object (PublicNetworkingConfiguration)

The public networking configuration for the network config

stableEgressIP
boolean

Enable stable egress IP

tlsTerminationPort
integer <int64>

The port that hosts the reverse proxy for TLS termination

zoneConfiguration
string
Enum: "SINGLE_ZONE_OMNISTRATE_RECOMMENDED" "SINGLE_ZONE_CUSTOMER_PROVIDED" "MULTI_ZONE"

The preferred type of zonal availability for this resource and the specific zone(s) to deploy in

Responses

Request samples

Content type
application/json
{
  • "description": "A multi-zone HA network config",
  • "endpointPerReplica": true,
  • "internal": true,
  • "name": "Multi-zone",
  • "openPorts": [
    ],
  • "publicNetworkingConfiguration": {
    },
  • "stableEgressIP": true,
  • "tlsTerminationPort": 443,
  • "zoneConfiguration": "SINGLE_ZONE_OMNISTRATE_RECOMMENDED"
}

Response samples

Content type
application/json
"nc-12345678"

DeleteNetworkConfig network-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service

id
required
string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][...
Example: nc-12345678

The ID of the network config

Responses

DescribeNetworkConfig network-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service

id
required
string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][...
Example: nc-12345678

The ID of the network config

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Id maiores ullam dolor aliquid omnis.

Product tier version of the network config to describe. If not specified, the latest version is described.

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Nostrum deserunt.

ProductTierId of the network config to describe. Needs to specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "description": "A multi-zone HA network config",
  • "endpointPerReplica": true,
  • "id": "nc-12345678",
  • "infraConfigIDs": [
    ],
  • "internal": true,
  • "name": "Multi-zone",
  • "openPorts": [
    ],
  • "publicNetworkingConfiguration": {
    },
  • "serviceId": "s-12345678",
  • "stableEgressIP": true,
  • "tlsTerminationPort": 443,
  • "zoneConfiguration": "SINGLE_ZONE_OMNISTRATE_RECOMMENDED"
}

UpdateNetworkConfig network-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The ID of the service

id
required
string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][...
Example: nc-12345678

The ID of the network config

Request Body schema: application/json
required
description
string

A brief description of the network config

endpointPerReplica
boolean

Generates a DNS endpoint per-replica for this network config

internal
boolean

Restrict access to this network config to the internal network

name
string

Name of the network config

openPorts
Array of integers <int64> [ items <int64 > ]

Ports to map to the generated DNS endpoint

object (PublicNetworkingConfiguration)

The public networking configuration for the network config

stableEgressIP
boolean

Create an external node load balancer per node rather than expose the node ip directly

tlsTerminationPort
integer <int64>

The port that hosts the reverse proxy for TLS termination

zoneConfiguration
string
Enum: "SINGLE_ZONE_OMNISTRATE_RECOMMENDED" "SINGLE_ZONE_CUSTOMER_PROVIDED" "MULTI_ZONE"

The preferred type of zonal availability for this resource and the specific zone(s) to deploy in

Responses

Request samples

Content type
application/json
{
  • "description": "A multi-zone HA network config",
  • "endpointPerReplica": true,
  • "internal": true,
  • "name": "Multi-zone",
  • "openPorts": [
    ],
  • "publicNetworkingConfiguration": {
    },
  • "stableEgressIP": true,
  • "tlsTerminationPort": 443,
  • "zoneConfiguration": "MULTI_ZONE"
}

availability-zone-api

The Availability Zone API provides read-only access to availability zones

DescribeAvailabilityZone availability-zone-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>az)-(?P<entityid>[a-zA-Z0-9][...
Example: az-12345678

ID of an AZ

Responses

Response samples

Content type
application/json
{
  • "cloudProviderName": "aws",
  • "code": "us-east-1a",
  • "description": "US East (N. Virginia) Availability Zone A",
  • "id": "az-12345678",
  • "regionCode": "us-east-1"
}

ListAvailabilityZone availability-zone-api

Authorizations:
api_key_header_Authorization
path Parameters
cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"
Example: aws

The cloud provider for this compute instance type config

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

GetAvailabilityZoneByCode availability-zone-api

Authorizations:
api_key_header_Authorization
path Parameters
code
required
string
Example: us-east-1a

Cloud-provider native availability zone code

cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"
Example: aws

The cloud provider for this compute instance type config

Responses

Response samples

Content type
application/json
"Ms. Dane Kling"

ListAvailabilityZonesByRegionCode availability-zone-api

Authorizations:
api_key_header_Authorization
path Parameters
regionCode
required
string
Example: us-east-1
cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"
Example: aws

The cloud provider for this compute instance type config

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

region-api

The Region API provides read-only access to regions

DescribeRegion region-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>region)-(?P<entityid>[a-zA-Z0...
Example: region-12345678

ID of the Region

Responses

Response samples

Content type
application/json
{
  • "cloudProviderId": "infra-12345678",
  • "cloudProviderName": "aws",
  • "code": "us-east-1",
  • "description": "US East (N. Virginia)",
  • "id": "region-12345678"
}

ListRegion region-api

Authorizations:
api_key_header_Authorization
path Parameters
cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"
Example: aws

The cloud provider for this compute instance type config

query Parameters
serviceId
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: serviceId=s-12345678

Service ID. If specified together with serviceModelId,list the regions of the service model. Otherwise list all regions.

serviceModelId
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: serviceModelId=sm-12345678

Service model ID. If specified together with serviceId,list the regions of the service model. Otherwise list all regions.

productTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: productTierId=pt-12345678

Product tier ID. If specified together with serviceId,list the regions of the product tier. Otherwise list all regions.

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

GetRegionByCode region-api

Authorizations:
api_key_header_Authorization
path Parameters
code
required
string non-empty
Example: us-east-1

Cloud-provider native region code

cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"
Example: aws

The cloud provider for this compute instance type config

Responses

Response samples

Content type
application/json
"Casimir Roberts"

cloud-provider-api

The Cloud Provider API provides read-only access to cloud provider metadata

ListCloudProvider cloud-provider-api

Authorizations:
api_key_header_Authorization
query Parameters
serviceId
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: serviceId=s-12345678

Service ID. If specified together with serviceModelId,list the cloud provider of the service model. Otherwise list all cloud provider.

serviceModelId
string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][...
Example: serviceModelId=sm-12345678

Service model ID. If specified together with serviceId,list the cloud provider of the service model. Otherwise list all cloud provider.

productTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: productTierId=pt-12345678

Product tier ID. If specified together with serviceId,list the cloud provider of the product tier. Otherwise list all cloud provider.

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

DescribeCloudProvider cloud-provider-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>infra)-(?P<entityid>[a-zA-Z0-...
Example: infra-12345678

ID of the CloudProvider

Responses

Response samples

Content type
application/json
{
  • "description": "Amazon Web Services",
  • "id": "infra-12345678",
  • "name": "aws"
}

GetCloudProviderByName cloud-provider-api

Authorizations:
api_key_header_Authorization
path Parameters
name
required
string non-empty
Example: aws

Name of the CloudProvider

Responses

Response samples

Content type
application/json
"Miles Hagenes"

demo-api

The Demo API provides a demo of the system

Demo demo-api

Request Body schema: application/json
required
company
required
string non-empty
email
required
string <email> non-empty
name
required
string non-empty
phone
string

Responses

Request samples

Content type
application/json
{}

contactus-api

The Contactus API for customers to reach out to us

Contactus contactus-api

Request Body schema: application/json
required
company
required
string non-empty
email
required
string <email> non-empty
message
required
string non-empty
name
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "company": "ABC",
  • "email": "[email protected]",
  • "message": "this is a test",
  • "name": "John Doe"
}

signin-api

The signin API for customers to authenticate with us

Signin signin-api

Request Body schema: application/json
required
email
required
string <email> non-empty
hashedPassword
string non-empty
password
string non-empty

Responses

Request samples

Content type
application/json
{}

Response samples

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

signup-api

The Signup API for customers to signup with us

ChangePassword signup-api

Request Body schema: application/json
required
email
required
string <email> non-empty
password
required
string non-empty
token
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "[email protected]",
  • "password": "password",
  • "token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6"
}

ResetPassword signup-api

Request Body schema: application/json
required
email
required
string <email> non-empty

Responses

Request samples

Content type
application/json
{}

Signup signup-api

Request Body schema: application/json
required
companyDescription
string non-empty
companyUrl
string non-empty
email
required
string <email> non-empty
legalCompanyName
required
string non-empty
name
required
string non-empty
password
required
string non-empty

Responses

Request samples

Content type
application/json
{}

RegenerateToken signup-api

path Parameters
id
required
string non-empty
Example: user-abcd1234

Responses

ValidateToken signup-api

Request Body schema: application/json
required
email
required
string <email> non-empty
token
required
string non-empty

Responses

Request samples

Content type
application/json
{}

plan-api

The Plan API is for payment info. It's explicitly empty for free plans.

DescribePlan plan-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "modifiedAt": "2023-01-01T00:00:00Z",
  • "nextChargeDate": "2023-02-01",
  • "paymentConfigured": true,
  • "paymentInfoPortalURL": "https://billing.paigo.com/stripe-portal?customerId=cus_xxxxxxxxxxxxxx",
  • "planCoreHourCost": 0.05,
  • "planDescription": "The starter plan is priced at 'X' units",
  • "planFrequency": "MONTHLY",
  • "planMonthlyCost": 49,
  • "planName": "STARTER",
  • "remainingCredits": "100",
  • "startDate": "2023-01-01"
}

ChangePlan plan-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
planName
required
string
Enum: "STARTER_NO_COMMIT" "STARTER" "GROWTH" "ENTERPRISE"

The name of the plan this user is changing to

Responses

Request samples

Content type
application/json
{
  • "planName": "STARTER"
}

usage-api

The Usage API is for getting the last calendar month usage for the current plan.

GetCurrentPlanUsage usage-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "endTime": "2021-01-01T00:00:00.000Z",
  • "planName": "STARTER",
  • "startTime": "2021-01-01T00:00:00.000Z",
  • "usage": [
    ]
}

invoice-api

The Invoices API gets the list of invoices for the current user

ListInvoices invoice-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{}

users-api

The user management API to manage user metadata

CustomerResetPassword users-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
email
required
string <email> non-empty

Responses

Request samples

Content type
application/json
{}

CustomerSignin users-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
email
required
string <email> non-empty
hashedPassword
string non-empty
password
string non-empty

Responses

Request samples

Content type
application/json
{}

Response samples

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

CustomerSignup users-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
companyDescription
string non-empty
companyUrl
string non-empty
email
required
string <email> non-empty
legalCompanyName
required
string non-empty
name
required
string non-empty
password
required
string non-empty

Responses

Request samples

Content type
application/json
{}

InviteUser users-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
email
required
string <email> non-empty
roleType
required
string
Enum: "root" "editor" "reader" "service_editor" "service_reader" "admin" "service_operator"

Responses

Request samples

Content type
application/json
{}

Logout users-api

Authorizations:
api_key_header_Authorization

Responses

DescribeUsersByOrg users-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "Id": "org-aKQ8G13QeR",
  • "orgUsers": [
    ]
}

RevokeUserRole users-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
email
required
string <email> non-empty
roleType
required
string
Enum: "root" "editor" "reader" "service_editor" "service_reader" "admin" "service_operator"

Responses

Request samples

Content type
application/json
{}

UpdatePassword users-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
currentPassword
string non-empty
currentPasswordHash
string non-empty
password
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "currentPassword",
  • "currentPasswordHash": "currentPasswordHash",
  • "password": "password"
}

DeleteUser users-api

Authorizations:
api_key_header_Authorization

Responses

DescribeUser users-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "address": {
    },
  • "createdAt": "2023-01-10T00:00:00Z",
  • "email": "[email protected]",
  • "id": "user-abcd1234",
  • "lastModifiedAt": "2023-01-20T00:00:00Z",
  • "name": "John Dae",
  • "orgDescription": "ACME Inc.",
  • "orgFavIconURL": "http://hillssporer.info/delphia",
  • "orgId": "org-aKQ8G13QeR",
  • "orgLogoURL": "http://west.com/raleigh",
  • "orgName": "ACME",
  • "orgPrivacyPolicy": "Id eos corporis facere vel.",
  • "orgSupportEmail": "[email protected]",
  • "orgTermsOfUse": "Tempora eos.",
  • "orgURL": "something.acme",
  • "planName": "STARTER",
  • "roleType": "reader"
}

UpdateUser users-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: user-abcd1234

The User ID

Request Body schema: application/json
required
object (Address)
name
string

The name of the user

orgDescription
string

The description of the org that this user owns

orgFavIconURL
string <uri>

The favicon of the org that this user owns

orgLogoURL
string <uri>

The logo of the org that this user owns

orgName
string

The org name that this user owns

orgPrivacyPolicy
string

The privacy policy for the org that this user owns in an HTML format

orgSupportEmail
string

The support email of the org that this user owns

orgTermsOfUse
string

The terms of use for the org that this user owns in an HTML format

orgURL
string

The url of the org that this user owns

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "name": "John Dae",
  • "orgDescription": "ACME Inc.",
  • "orgFavIconURL": "http://botsford.name/nils",
  • "orgLogoURL": "http://feeney.com/murray.beahan",
  • "orgName": "ACME",
  • "orgPrivacyPolicy": "Quidem natus est velit molestiae nisi sequi.",
  • "orgSupportEmail": "[email protected]",
  • "orgTermsOfUse": "Et libero accusantium.",
  • "orgURL": "something.acme"
}

consumption-user-api

The Consumption Signin API signs the user into the consumption service

InviteUser consumption-user-api

Authorizations:
api_key_header_Authorization
path Parameters
subscriptionId
required
string
Example: sub-abcd1234

The subscription ID

Request Body schema: application/json
required
email
required
string <email> non-empty
roleType
required
string
Enum: "root" "editor" "reader" "service_editor" "service_reader" "admin" "service_operator"

Responses

Request samples

Content type
application/json
{}

RevokeUserRole consumption-user-api

Authorizations:
api_key_header_Authorization
path Parameters
subscriptionId
required
string
Example: sub-abcd1234

The subscription ID

Request Body schema: application/json
required
email
required
string <email> non-empty
roleType
required
string
Enum: "root" "editor" "reader" "service_editor" "service_reader" "admin" "service_operator"

Responses

Request samples

Content type
application/json
{}

DescribeUsersBySubscription consumption-user-api

Authorizations:
api_key_header_Authorization
path Parameters
subscriptionId
required
string
Example: sub-abcd1234

The subscription ID

Responses

Response samples

Content type
application/json
{
  • "Id": "sub-abcd1234",
  • "subscriptionUsers": [
    ]
}

DescribeUserBillingDetails consumption-user-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>user)-(?P<entityid>[a-zA-Z0-9...
Example: user-abcd1234

ID of a User

Responses

Response samples

Content type
application/json
{}

Signin consumption-user-api

Authorizations:
basic_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "token": "k"
}

resource-instance-api

The Resource Instance API manages the instances of a resource

ListResourceInstances resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service key

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Request Body schema: application/json
required
cloud_provider
string

The cloud provider name

externalBillingId
string

The external billing id to record which customer should pay for this resource instance

network_type
string
Enum: "PUBLIC" "PRIVATE_VPC_PEERING" "PRIVATE_LINK"

The network type

region
string

The region code

requestParams
string <binary>

The request parameters

Responses

Request samples

Content type
application/json
{
  • "cloud_provider": "aws",
  • "externalBillingId": "external-billing-id-1234",
  • "network_type": "PUBLIC",
  • "region": "us-east-1",
  • "requestParams": {
    }
}

Response samples

Content type
application/json
{
  • "id": "Cumque cumque sed."
}

DeleteResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

DescribeResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "awsAccountID": "123456789012",
  • "cloud_provider": "aws",
  • "created_at": "2023-01-10T00:00:00Z",
  • "createdByUserId": "user-12345678",
  • "createdByUserName": "John Doe",
  • "detailedNetworkTopology": {
    },
  • "externalPayerId": "external-payer-id-1234",
  • "gcpProjectID": "my-project",
  • "id": "instance-abcd1234",
  • "last_modified_at": "2023-01-20T00:00:00Z",
  • "network_type": "PUBLIC",
  • "productTierFeatures": {
    },
  • "region": "us-east-1",
  • "result_params": {
    },
  • "status": "RUNNING"
}

UpdateResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Request Body schema: application/json
required
requestParams
string <binary>

The request parameters

Responses

Request samples

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

AddCapacityToResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Request Body schema: application/json
required
capacityToBeAdded
required
integer <int64>

Number of replicas to be added

Responses

Request samples

Content type
application/json
{
  • "capacityToBeAdded": 3
}

FailoverResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Request Body schema: application/json
required
failedReplicaAction
string
Enum: "FAILOVER_ONLY" "FAILOVER_AND_RESTART" "FAILOVER_AND_RECREATE"

The failed replica action

failedReplicaID
required
string

The failed replica ID

Responses

Request samples

Content type
application/json
{
  • "failedReplicaAction": "FAILOVER_AND_RESTART",
  • "failedReplicaID": "db-0"
}

RemoveCapacityFromResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Request Body schema: application/json
required
capacityToBeRemoved
required
integer <int64>

Number of replicas to be removed

Responses

Request samples

Content type
application/json
{
  • "capacityToBeRemoved": 3
}

RestartResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

StartResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

StopResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

ResourceInstanceProvisionerSetupKit resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

account-config-api

The Account Config API manages the access information for a Service Provider account

CreateAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
awsAccessKey
string

The AWS access key

awsAccountID
string

The AWS account ID

awsBootstrapRoleARN
string

The security role ARN or service account ARN that grants access to operate the infra

awsSecretKey
string

The AWS secret key

byoaInstanceID
string

The BYOA instance ID that this account config is tied to

cloudProviderId
required
string^(?P<entitytype>infra)-(?P<entityid>[a-zA-Z0-...

Cloud Provider ID to operate on

description
required
string

The description for the account

gcpProjectID
string

The GCP project ID

gcpProjectNumber
string

The GCP project number

gcpServiceAccountEmail
string

The GCP service account email

gcpServiceAccountKey
string

The GCP service account key

name
required
string

The name of the account

Responses

Request samples

Content type
application/json
{
  • "awsAccessKey": "Dolore aspernatur.",
  • "awsAccountID": "123456789012",
  • "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
  • "awsSecretKey": "Non iure ut.",
  • "byoaInstanceID": "instance-12345678",
  • "cloudProviderId": "infra-12345678",
  • "description": "An AWS account hosting multiple dev environments",
  • "gcpProjectID": "my-project",
  • "gcpProjectNumber": "123456789012",
  • "gcpServiceAccountEmail": "[email protected]",
  • "gcpServiceAccountKey": "Illo consequatur omnis.",
  • "name": "Dev AWS account"
}

Response samples

Content type
application/json
"ac-12345678"

DeleteAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...
Example: ac-12345678

Account Config ID to operate on

Responses

DescribeAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...
Example: ac-12345678

Account Config ID to operate on

Responses

Response samples

Content type
application/json
{
  • "awsAccountID": "123456789012",
  • "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
  • "awsCloudFormationTemplateURL": "https://s3.amazonaws.com/my-bucket/my-template.json",
  • "byoaInstanceIDs": [
    ],
  • "cloudProviderId": "infra-12345678",
  • "description": "An AWS account hosting multiple dev environments",
  • "gcpProjectID": "my-project",
  • "gcpProjectNumber": "123456789012",
  • "gcpServiceAccountEmail": "[email protected]",
  • "id": "ac-12345678",
  • "name": "Dev AWS account",
  • "status": "READY",
  • "statusMessage": "Account is ready"
}

UpdateAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...
Example: ac-12345678

Account Config ID to operate on

Request Body schema: application/json
required
awsAccessKey
string

The AWS access key

awsSecretKey
string

The AWS secret key

bootstrapRoleARN
string

The security role ARN or service account ARN that grants access to operate the infra

description
string

The description for the account

gcpServiceAccountEmail
string

The GCP service account email

gcpServiceAccountKey
string

The GCP service account key

name
string

The name of the account

Responses

Request samples

Content type
application/json
{
  • "awsAccessKey": "Dolores id voluptatem et.",
  • "awsSecretKey": "Vitae rerum.",
  • "bootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
  • "description": "An AWS account hosting multiple dev environments",
  • "gcpServiceAccountEmail": "[email protected]",
  • "gcpServiceAccountKey": "Voluptatum mollitia esse.",
  • "name": "Dev AWS account"
}

DescribeAccountConfigByAWSAccountID account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
awsAccountID
required
string
Example: 123456789012

The AWS account ID

Responses

Response samples

Content type
application/json
{
  • "awsAccountID": "123456789012",
  • "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
  • "awsCloudFormationTemplateURL": "https://s3.amazonaws.com/my-bucket/my-template.json",
  • "byoaInstanceIDs": [
    ],
  • "cloudProviderId": "infra-12345678",
  • "description": "An AWS account hosting multiple dev environments",
  • "id": "ac-12345678",
  • "name": "Dev AWS account",
  • "status": "READY",
  • "statusMessage": "Account is ready"
}

ListBYOAConfig account-config-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"

Cloud Provider name to filter on

Responses

Request samples

Content type
application/json
{
  • "cloudProviderName": "aws"
}

Response samples

Content type
application/json
{
  • "accountConfigs": [
    ],
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

ListAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
cloudProviderName
required
string
Enum: "aws" "azure" "gcp" "all"
Example: aws

Cloud Provider name to filter on

Responses

Response samples

Content type
application/json
{
  • "accountConfigs": [
    ],
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

DescribeAccountConfigByGCPProjectID account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
gcpProjectID
required
string
Example: my-project

The GCP project ID

Responses

Response samples

Content type
application/json
{
  • "byoaInstanceIDs": [
    ],
  • "cloudProviderId": "infra-12345678",
  • "description": "An AWS account hosting multiple dev environments",
  • "gcpProjectID": "my-project",
  • "gcpProjectNumber": "123456789012",
  • "gcpServiceAccountEmail": "[email protected]",
  • "id": "ac-12345678",
  • "name": "Dev AWS account",
  • "status": "READY",
  • "statusMessage": "Account is ready"
}

AccountConfigIdentityID account-config-api

Returns the identity id of the account config to be used in the trust policy of the account

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "org-12345678"
}

VerifyAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...
Example: ac-12345678

Account Config ID to operate on

Responses

custom-domain-api

The Custom Domain API manages the delegated domain names for the Service Provider

ListCustomDomain custom-domain-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "CustomDomains": [
    ],
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateCustomDomain custom-domain-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
customDomain
required
string

The root domain of the domain to use as suffix

description
required
string

The description for the domain

name
required
string

The name of the custom domain

required
object (Route53Configuration)

Responses

Request samples

Content type
application/json
{
  • "customDomain": "mydomain.dev",
  • "description": "Description of the domain",
  • "name": "Dev domain",
  • "route53Configuration": {
    }
}

Response samples

Content type
application/json
"cd-12345678"

DeleteCustomDomain custom-domain-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>cd)-(?P<entityid>[a-zA-Z0-9][...
Example: cd-12345678

custom domain ID to operate on

Responses

DescribeCustomDomain custom-domain-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>cd)-(?P<entityid>[a-zA-Z0-9][...
Example: cd-12345678

custom domain ID to operate on

Responses

Response samples

Content type
application/json
{
  • "customDomain": "mydomain.dev",
  • "description": "Description of the domain",
  • "id": "cd-12345678",
  • "name": "Dev domain",
  • "route53Configuration": {},
  • "status": "READY",
  • "statusMessage": "Account is ready"
}

CustomDomainIdentityID custom-domain-api

Returns the identity id of the Custom Domain to be used in the trust policy of the account

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "id": "org-12345678"
}

VerifyCustomDomain custom-domain-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>cd)-(?P<entityid>[a-zA-Z0-9][...
Example: cd-12345678

custom domain ID to operate on

Responses

limit-api

The limit API manages the limit for Omnistrate entities

ListLimit limit-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
family
required
string
Enum: "SERVICE" "COMPUTE_INFRA" "STORAGE_INFRA" "NETWORK_INFRA" "OTHER_INFRA"

Limit family

Responses

Request samples

Content type
application/json
{
  • "family": "COMPUTE_INFRA"
}

Response samples

Content type
application/json
{
  • "keys": [
    ],
  • "nextPageToken": "next-token"
}

DeleteLimit limit-api

Authorizations:
api_key_header_Authorization
path Parameters
family
required
string
Enum: "SERVICE" "COMPUTE_INFRA" "STORAGE_INFRA" "NETWORK_INFRA" "OTHER_INFRA"
Example: COMPUTE_INFRA

Limit family

key
required
string
Example: MAX_VIRTUAL_CORES_PER_RESOURCE

Unique key to identify the limit

Responses

DescribeLimit limit-api

Authorizations:
api_key_header_Authorization
path Parameters
family
required
string
Enum: "SERVICE" "COMPUTE_INFRA" "STORAGE_INFRA" "NETWORK_INFRA" "OTHER_INFRA"
Example: COMPUTE_INFRA

Limit family

key
required
string
Example: MAX_VIRTUAL_CORES_PER_RESOURCE

Unique key to identify the limit

Responses

Response samples

Content type
application/json
{
  • "description": "A premium limit",
  • "family": "COMPUTE_INFRA",
  • "key": "MAX_VIRTUAL_CORES_PER_RESOURCE",
  • "modifiable": true,
  • "name": "Premium Tier",
  • "value": 4
}

UpdateLimit limit-api

Authorizations:
api_key_header_Authorization
path Parameters
family
required
string
Enum: "SERVICE" "COMPUTE_INFRA" "STORAGE_INFRA" "NETWORK_INFRA" "OTHER_INFRA"
Example: COMPUTE_INFRA

Limit family

key
required
string
Example: MAX_VIRTUAL_CORES_PER_RESOURCE

Unique key to identify the limit

Request Body schema: application/json
required
description
string

A brief description of the limit

name
string

Name of the limit

value
required
integer <int64>

Value of the limit being enforced

Responses

Request samples

Content type
application/json
{
  • "description": "A premium limit",
  • "name": "Premium Tier",
  • "value": 4
}

image-registry-api

The image registry API manages the image registry for Omnistrate resources

ListImageRegistry image-registry-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token"
}

CreateImageRegistry image-registry-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
description
required
string

A brief description of the Image Registry

host
required
string

The Image Registry host

name
required
string

Name of the Image Registry

password
string

The password to use when authenticating to the Image Registry

username
string

The username to use when authenticating to the Image Registry

Responses

Request samples

Content type
application/json
{
  • "description": "DockerHub is a public Docker Image Registry",
  • "host": "docker.io",
  • "name": "DockerHub",
  • "password": "mypassword",
  • "username": "myusername"
}

Response samples

Content type
application/json
"ir-12345678"

DeleteImageRegistry image-registry-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][...
Example: ir-12345678

The ID of the Image Registry

Responses

DescribeImageRegistry image-registry-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][...
Example: ir-12345678

The ID of the Image Registry

Responses

Response samples

Content type
application/json
{
  • "description": "DockerHub is a public Docker Image Registry",
  • "host": "docker.io",
  • "id": "ir-12345678",
  • "name": "DockerHub",
  • "username": "myusername"
}

UpdateImageRegistry image-registry-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][...
Example: ir-12345678

The ID of the Image Registry

Request Body schema: application/json
required
description
string

A brief description of the Image Registry

host
string

The Image Registry host

name
string

Name of the Image Registry

password
string

The password to use when authenticating to the Image Registry

username
string

The username to use when authenticating to the Image Registry

Responses

Request samples

Content type
application/json
{
  • "description": "DockerHub is a public Docker Image Registry",
  • "host": "docker.io",
  • "name": "DockerHub",
  • "password": "mypassword",
  • "username": "myusername"
}

service-offering-api

The service offering API provides a public API to list all public services

ListServiceOffering service-offering-api

Authorizations:
api_key_header_Authorization
query Parameters
orgId
string^(?P<entitytype>org)-(?P<entityid>[a-zA-Z0-9]...
Example: orgId=org-12345678

Org Id

visibility
string
Enum: "PUBLIC" "PRIVATE"
Example: visibility=PRIVATE

The visibility of service offering

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "next-token",
  • "serviceIds": [
    ],
  • "services": [
    ]
}

DescribeServiceOffering service-offering-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

query Parameters
visibility
string
Enum: "PUBLIC" "PRIVATE"
Example: visibility=PRIVATE

The visibility of service offering

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-01-01T00:00:00Z",
  • "isDeprecated": false,
  • "offerings": [
    ],
  • "serviceDescription": "MySQL is a relational database",
  • "serviceId": "s-12345678",
  • "serviceName": "MySQL",
  • "serviceOrgId": "org-12345678",
  • "serviceProviderId": "sp-9zrg9W8Are",
  • "serviceProviderName": "Omnistrate, Inc.",
  • "serviceURLKey": "mysql"
}

DescribeServiceOfferingResource service-offering-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: s-12345678

The service ID

resourceId
required
string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a...
Example: r-12345678

The resource ID

instanceId
required
string
Default: "none"
Example: instance-12345678

The instance ID

Responses

Response samples

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

event-api

The event API manages the event for Omnistrate entities

ListEvent event-api

Authorizations:
api_key_header_Authorization
path Parameters
instanceId
required
string
Example: instance-12345678

The ID of the resource instance

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "ids": [
    ],
  • "nextPageToken": "token"
}

ListAllEvent event-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][...
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "ids": [
    ],
  • "nextPageToken": "token"
}

DescribeEvent event-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>event)-(?P<entityid>[a-zA-Z0-...
Example: event-12345678

The ID of the event

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "id": "event-12345678",
  • "message": "instance-abcd1234 created",
  • "resourceInstanceId": "instance-abcd1234",
  • "resourceName": "Galera",
  • "time": "2023-01-10T00:00:00Z"
}

subscription-api

The subscription management API to manage subscription metadata

ListSubscriptions subscription-api

Authorizations:
api_key_header_Authorization
query Parameters
serviceId
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...
Example: serviceId=service-12345678

Service Id

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token",
  • "subscriptions": [
    ]
}

CreateSubscription subscription-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...

The product tier ID

serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...

The service ID

Responses

Request samples

Content type
application/json
{
  • "productTierId": "pt-12345678",
  • "serviceId": "s-12345678"
}

Response samples

Content type
application/json
"sub-12345678"

DeleteSubscription subscription-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>sub)-(?P<entityid>[a-zA-Z0-9]...
Example: sub-12345678

The subscription ID

Responses

DescribeSubscription subscription-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>sub)-(?P<entityid>[a-zA-Z0-9]...
Example: sub-12345678

The subscription ID

Responses

Response samples

Content type
application/json
{
  • "accountConfigIdentityId": "org-12345678",
  • "cloudProviderNames": [
    ],
  • "createdAt": "2019-01-01T00:00:00Z",
  • "defaultSubscription": true,
  • "id": "sub-12345678",
  • "productTierId": "pt-12345678",
  • "productTierName": "Omnistrate Multi Tenancy",
  • "roleType": "root",
  • "rootUserId": "user-12345678",
  • "serviceId": "s-12345678",
  • "serviceLogoURL": "http://rice.net/julio.zemlak",
  • "serviceName": "MySQL multi-writer service",
  • "serviceOrgId": "org-12345678",
  • "serviceOrgName": "Omnistrate",
  • "status": "ACTIVE",
  • "subscriptionOwnerName": "John Doe"
}

subscription-request-api

The subscription request API for end customers to issue subscription requests

ListSubscriptionRequests subscription-request-api

Authorizations:
api_key_header_Authorization
query Parameters
status
string
Enum: "PENDING" "APPROVED" "DENIED" "CANCELLED"
Example: status=PENDING

The status of the subscription request to filter by

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "nextPageToken": "next-token",
  • "subscriptionRequests": [
    ]
}

CreateSubscriptionRequest subscription-request-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
productTierId
required
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...

The product tier ID

serviceId
required
string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a...

The service ID

Responses

Request samples

Content type
application/json
{
  • "productTierId": "pt-12345678",
  • "serviceId": "s-12345678"
}

Response samples

Content type
application/json
"subr-12345678"

CancelSubscriptionRequest subscription-request-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>subr)-(?P<entityid>[a-zA-Z0-9...
Example: subr-12345678

The subscription ID

Responses

DescribeSubscriptionRequest subscription-request-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>subr)-(?P<entityid>[a-zA-Z0-9...
Example: subr-12345678

The subscription ID

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-01-01T00:00:00Z",
  • "id": "subr-12345678",
  • "productTierId": "pt-12345678",
  • "productTierName": "Omnistrate Multi Tenancy",
  • "rootUserEmail": "[email protected]",
  • "rootUserId": "org-12345678",
  • "rootUserName": "John Doe",
  • "serviceId": "s-12345678",
  • "serviceLogoURL": "http://boylelarkin.biz/jeramy",
  • "serviceName": "MySQL multi-writer service",
  • "status": "PENDING",
  • "updatedAt": "2019-01-01T00:00:00Z",
  • "updatedByUserId": "user-12345678",
  • "updatedByUserName": "John Doe"
}

workflow-api

ListWorkflow workflow-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
[
  • "Ex adipisci velit ratione voluptas dolorem corporis.",
  • "Tenetur aperiam autem.",
  • "Sit rerum et cupiditate quos praesentium beatae."
]

CreateWorkflow workflow-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
operationType
required
string
Enum: "CREATE" "READ" "UPDATE" "LIST" "DELETE" "CUSTOM"
resourceId
required
string
serviceInstanceId
required
string
object (WorkflowVerb)

Responses

Request samples

Content type
application/json
{
  • "operationType": "DELETE",
  • "resourceId": "Modi doloremque voluptatem aut omnis neque dignissimos.",
  • "serviceInstanceId": "Iusto unde enim.",
  • "verb": {
    }
}

Response samples

Content type
application/json
"Ressie Wisoky"

DeleteWorkflow workflow-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>workflowtemplate)-(?P<entityi...
Example: w-12345

Responses

Response samples

Content type
application/json
{
  • "code": "12-999",
  • "message": "Required field `x` was not provided in the request",
  • "name": "missing_field"
}

DescribeWorkflow workflow-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>workflowtemplate)-(?P<entityi...
Example: w-12345

Responses

Response samples

Content type
application/json
"Praesentium deleniti et doloribus rem."

ExecuteWorkflow workflow-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string^(?P<entitytype>workflowtemplate)-(?P<entityi...
Example: w-12345

Responses

Response samples

Content type
application/json
{
  • "code": "12-999",
  • "message": "Required field `x` was not provided in the request",
  • "name": "missing_field"
}