API docs by Redocly

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

Download OpenAPI specification:

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": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED"
}

consumptionServiceHealth global-api

Consumption service health check endpoint

Responses

Response samples

Content type
application/json
{
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED"
}

consumptionServiceVersion global-api

Consumption service version endpoint

Responses

Response samples

Content type
application/json
{
  • "additionalVersions": {
    },
  • "apiVersion": "1.0",
  • "buildCommitSHA": "1234567890abcdef1234567890abcdef12345678",
  • "buildTimestamp": "2020-01-01T00:00:00Z",
  • "componentVersion": "v0.47.96"
}

registrationServiceVersion global-api

Registration service version endpoint

Responses

Response samples

Content type
application/json
{
  • "additionalVersions": {
    },
  • "apiVersion": "1.0",
  • "buildCommitSHA": "1234567890abcdef1234567890abcdef12345678",
  • "buildTimestamp": "2020-01-01T00:00:00Z",
  • "componentVersion": "v0.47.96"
}

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
{}

Response samples

Content type
application/json
"s-123456"

DeleteService service-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: s-12345678

The service ID to operate on

Responses

DescribeService service-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
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-123456",
  • "key": "mysql",
  • "name": "MySQL multi-writer service",
  • "roleType": "root|editor|reader|service_editor|service_reader|admin|service_operator",
  • "serviceEnvironments": [
    ],
  • "serviceLogoURL": "Beatae voluptas.",
  • "serviceProviderID": "Voluptatem rerum.",
  • "serviceProviderName": "Omnistrate, Inc."
}

UpdateService service-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: s-12345678

The service ID to operate on

Request Body schema: application/json
required
description
string

A brief description of the service

dryRun
boolean

If set to true, performs a dry run of the update operation without making any changes

name
string

Name of the Service

serviceLogoURL
string

The logo for the service

Responses

Request samples

Content type
application/json
{
  • "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
  • "dryRun": true,
  • "name": "MySQL multi-writer service",
  • "serviceLogoURL": "Praesentium expedita libero aliquid ex possimus."
}

ServiceHealth service-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: s-12345678

The ID of the service

Responses

Response samples

Content type
application/json
{
  • "health": "UP|DOWN|UNKNOWN",
  • "id": "s-123456",
  • "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": "Omnis sed ab id provident.",
  • "fileFormat": "text/plain",
  • "fileName": "mysql.yaml",
  • "name": "MySQL multi-writer service",
  • "serviceLogoURL": "http://conroymcdermott.com/zack"
}

Response samples

Content type
application/json
"s-123456"

BuildServiceFromComposeSpec service-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
object

Configs for the service. Key is the compose spec name of the config and value is base64 encoded config content

description
string

A brief description of the service

dryrun
boolean

If set to true, performs a dry run of the build operation without making any changes

environment
string

The environment to build the service in

environmentType
string

The type of the environment

fileContent
required
string

Base64 encoded Compose Spec YAML in docker compose format

forceCreateNewServicePlanVersion
boolean

Force create a new service plan version when the service is released

name
required
string

Name of the Service

release
boolean

Release the service after building

releaseAsPreferred
boolean

Release the service as preferred

releaseVersionName
string

Release version name

object

Secrets for the service. Key is the compose spec name of the secret and value is base64 encoded secret content

serviceLogoURL
string <uri>

The logo for the service

Responses

Request samples

Content type
application/json
{
  • "configs": {
    },
  • "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
  • "dryrun": true,
  • "environment": "dev",
  • "environmentType": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "fileContent": "Id aut vitae dicta non corporis ab.",
  • "forceCreateNewServicePlanVersion": true,
  • "name": "MySQL multi-writer service",
  • "release": true,
  • "releaseAsPreferred": true,
  • "releaseVersionName": "mysql",
  • "secrets": {
    },
  • "serviceLogoURL": "http://hilpert.org/chaz"
}

Response samples

Content type
application/json
{
  • "isNewServicePlanVersionCreated": true,
  • "productTierID": "Et neque nihil quibusdam minima non.",
  • "serviceEnvironmentID": "se-123456",
  • "serviceID": "s-123456",
  • "undefinedResources": {
    }
}

BuildServiceFromServicePlanSpec service-api

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

A brief description of the service

dryrun
boolean

If set to true, performs a dry run of the build operation without making any changes

environment
string

The environment to build the service in

environmentType
string

The type of the environment

fileContent
required
string

Base64 encoded Compose Spec YAML in service plan configuration format

forceCreateNewServicePlanVersion
boolean

Force create a new service plan version when the service is released

name
required
string

Name of the Service

release
boolean

Release the service after building

releaseAsPreferred
boolean

Release the service as preferred

releaseVersionName
string

Release version name

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",
  • "dryrun": true,
  • "environment": "dev",
  • "environmentType": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "fileContent": "Labore qui voluptatem occaecati.",
  • "forceCreateNewServicePlanVersion": true,
  • "name": "MySQL multi-writer service",
  • "release": true,
  • "releaseAsPreferred": true,
  • "releaseVersionName": "mysql",
  • "serviceLogoURL": "http://beahan.name/kelley_schiller"
}

Response samples

Content type
application/json
{
  • "isNewServicePlanVersionCreated": true,
  • "productTierID": "Et consequatur dolor est saepe velit voluptas.",
  • "serviceEnvironmentID": "se-123456",
  • "serviceID": "s-123456",
  • "undefinedResources": {
    }
}

PrepareServiceFromServicePlanSpec service-api

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

The ID of the onboarding of the service

environment
required
string

The environment to build the service in

environmentType
required
string

The type of the environment

fileContent
required
string

Base64 encoded Compose Spec YAML in service plan configuration format

name
required
string

Name of the Service

Responses

Request samples

Content type
application/json
{
  • "customerOnboardingId": "Qui numquam cumque temporibus.",
  • "environment": "dev",
  • "environmentType": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "fileContent": "Quis sunt.",
  • "name": "MySQL multi-writer service"
}

Response samples

Content type
application/json
{
  • "artifactUploadingTasks": [
    ],
  • "isNewProductTierCreated": true,
  • "productTierID": "Illum expedita sit explicabo delectus aut.",
  • "serviceEnvironmentID": "se-123456",
  • "serviceID": "s-123456"
}

service-environment-api

ListServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
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
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

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

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

type
string
visibility
string

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

Responses

Request samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "deploymentConfigId": "Ut aut omnis vero facilis.",
  • "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-123456",
  • "type": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "visibility": "PUBLIC"
}

Response samples

Content type
application/json
"se-123456"

DeleteServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service this environment belongs to

id
required
string
Example: se-12345678

The ID of the service environment

Responses

DescribeServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service this environment belongs to

id
required
string
Example: se-12345678

The ID of the service environment

Responses

Response samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "deploymentConfigId": "Minus soluta nam.",
  • "description": "The production environment for the MySQL multi-writer service",
  • "id": "se-123456",
  • "key": "production",
  • "name": "Production",
  • "promotionStatus": [
    ],
  • "roleType": "root|editor|reader|service_editor|service_reader|admin|service_operator",
  • "saasPortalStatus": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "saasPortalUrl": "https://saas-portal.example.com",
  • "serviceAuthPublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
  • "serviceId": "s-123456",
  • "sourceEnvironmentId": "se-123456",
  • "type": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "visibility": "PUBLIC"
}

UpdateServiceEnvironment service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service this environment belongs to

id
required
string
Example: se-12345678

The ID of the service environment

Request Body schema: application/json
required
autoApproveSubscription
boolean

Auto approve subscription or not

deploymentConfigId
string

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

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

Responses

Request samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "deploymentConfigId": "Consequatur dolor.",
  • "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"
}

PromoteServiceEnvironmentStatus service-environment-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service this environment belongs to

id
required
string
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
Example: s-12345678

The ID of the service this environment belongs to

id
required
string
Example: se-12345678

The ID of the service environment

Request Body schema: application/json
required
productTierId
string

The ID of the product tier to use for the promotion

productTierVersion
string

The product tier version to use for the promotion

Responses

Request samples

Content type
application/json
{
  • "productTierId": "Ipsum temporibus et aperiam.",
  • "productTierVersion": "1.0"
}

service-model-api

CreateServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service this model is for

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

The infrastructure account configuration ID list

description
required
string

A brief description of the service model

Array of objects (ServiceModelFeatureDetail)

Enabled service model features

modelType
required
string

The model type encapsulating this service

name
required
string

Name of the Service Model

serviceApiId
required
string

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",
  • "features": [
    ],
  • "modelType": "OMNISTRATE_HOSTED|CUSTOMER_HOSTED|BYOA",
  • "name": "MySQL multi-writer service hosted model",
  • "serviceApiId": "Pariatur fugiat sequi iusto."
}

Response samples

Content type
application/json
"Dicta quasi odio dolores."

DeleteServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
Example: sm-12345678

The service model ID

Responses

DescribeServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
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",
  • "features": [
    ],
  • "id": "Quas rerum voluptates illum quos.",
  • "key": "mysql-multi-writer-service-hosted-model",
  • "modelType": "OMNISTRATE_HOSTED|CUSTOMER_HOSTED|BYOA",
  • "name": "MySQL multi-writer service hosted model",
  • "productTiers": [
    ],
  • "serviceApiId": "Veniam libero assumenda quo.",
  • "serviceId": "s-123456"
}

UpdateServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
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"
}

RemoveAccountConfigFromServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
Example: sm-12345678

The service model ID

Request Body schema: application/json
required
accountConfigId
required
string

The infrastructure account configuration ID

Responses

Request samples

Content type
application/json
{
  • "accountConfigId": "Nulla ea eum corporis consequuntur laboriosam consectetur."
}

AddAccountConfigToServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
Example: sm-12345678

The service model ID

Request Body schema: application/json
required
accountConfigId
required
string

The infrastructure account configuration ID

Responses

Request samples

Content type
application/json
{
  • "accountConfigId": "Nobis eligendi ut veniam aut libero."
}

SetActiveAccountConfig service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
Example: sm-12345678

The service model ID

accountConfigId
required
string
Example: ac-12345678

The infrastructure account configuration ID

Responses

DisableServiceModelFeature service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
Example: sm-12345678

The service model ID

Request Body schema: application/json
required
feature
required
string

Responses

Request samples

Content type
application/json
{
  • "feature": "CUSTOM_NETWORKS|CUSTOM_TERRAFORM_POLICY|CUSTOM_AGENT_RBAC"
}

EnableServiceModelFeature service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
Example: sm-12345678

The service model ID

Request Body schema: application/json
required
required
object
feature
required
string

Responses

Request samples

Content type
application/json
{
  • "configuration": {
    },
  • "feature": "CUSTOM_NETWORKS|CUSTOM_TERRAFORM_POLICY|CUSTOM_AGENT_RBAC"
}

ReleaseServiceModelStatus service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

id
required
string
Example: sm-12345678

The service model ID

Responses

Response samples

Content type
application/json
{
  • "status": "DEPLOYING|READY|PENDING|FAILED|NOT_CONFIGURED"
}

CopyServiceModel service-model-api

DEPRECATED: Create a new service model from spec instead

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID this model belongs to

sourceId
required
string
Example: sm-12345678

The source service model ID

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

The infrastructure account configuration ID list

description
required
string

A brief description of the service model

Array of objects (ServiceModelFeatureDetail)

Enabled service model features

name
required
string

Name of the Service Model

targetServiceModelType
required
string

The model type encapsulating this service

targetTierType
string

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",
  • "features": [
    ],
  • "name": "MySQL multi-writer service hosted model",
  • "targetServiceModelType": "OMNISTRATE_HOSTED|CUSTOMER_HOSTED|BYOA",
  • "targetTierType": "OMNISTRATE_DEDICATED_TENANCY|OMNISTRATE_MULTI_TENANCY|CUSTOM_TENANCY"
}

Response samples

Content type
application/json
"Quod voluptates atque et aliquam quia."

ListServiceModel service-model-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

serviceApiId
required
string
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
Example: s-12345678

Service ID

serviceModelId
required
string
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
Example: s-12345678

Service ID

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
boolean

Allow creates when payment not configured

autoApproveSubscription
boolean

Auto approve subscription or not

awsRegions
Array of strings

The AWS regions that this product tier is available on

azureRegions
Array of strings

The Azure regions that this product tier is available on

billingProductID
string

Optional billing product ID for tax purposes

billingProviders
Array of strings

List of billing providers to be used for the product tier

byocOnpremRegions
Array of strings

The BYOC on-prem regions that this product tier is available on

object (CustomMeteringConfiguration)
defaultBillingProvider
string

The default billing provider to be used for the product tier

object (ProductTierDeploymentConfiguration)
description
required
string

A brief description of the product tier

disableInvoiceGeneration
boolean

Whether Stripe invoice generation is disabled for this product tier

documentation
string

Documentation

enableDeletionProtection
boolean

Enable deletion protection for the product tier

exportUsageMetering
boolean

Export usage metering data

object

Export usage metering data configuration

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.

maxNumberOfInstances
integer <int64>

Maximum number of instances

name
required
string

Name of the product tier

nebiusRegions
Array of strings

The Nebius regions that this product tier is available on

ociRegions
Array of strings

The OCI regions that this product tier is available on

onPremPlatforms
Array of strings

The on prem platforms that this product tier is available on

planDescription
required
string

A brief description for the end user of the product tier

object

Price per unit.

pricing
any

Pricing

privateRegions
Array of strings

The private regions that this product tier is available on

serviceModelId
required
string

Service model ID

support
string

Support

tierType
required
string

Tier type

Responses

Request samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "autoApproveSubscription": false,
  • "awsRegions": [
    ],
  • "azureRegions": [
    ],
  • "billingProductID": "abc123",
  • "billingProviders": [
    ],
  • "byocOnpremRegions": [
    ],
  • "customMetering": {
    },
  • "defaultBillingProvider": "STRIPE|BRING_YOUR_OWN",
  • "deploymentConfiguration": {
    },
  • "description": "A premium product tier",
  • "disableInvoiceGeneration": false,
  • "documentation": "Any documentation",
  • "enableDeletionProtection": false,
  • "exportUsageMetering": true,
  • "exportUsageMeteringConfig": {
    },
  • "gcpRegions": [
    ],
  • "isDisabled": false,
  • "maxNumberOfInstances": 5,
  • "name": "Premium",
  • "nebiusRegions": [
    ],
  • "ociRegions": [
    ],
  • "onPremPlatforms": [
    ],
  • "planDescription": "A premium plan",
  • "pricePerUnit": {
    },
  • "pricing": {
    },
  • "privateRegions": [
    ],
  • "serviceModelId": "Voluptatum voluptate placeat assumenda.",
  • "support": "Any support",
  • "tierType": "OMNISTRATE_DEDICATED_TENANCY|OMNISTRATE_MULTI_TENANCY|CUSTOM_TENANCY"
}

Response samples

Content type
application/json
"Eos ipsam deserunt."

DeleteProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

Responses

DescribeProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

query Parameters
version
string
Example: version=3.0

The version number for the specific version set

Responses

Response samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "apiGroups": {
    },
  • "autoApproveSubscription": false,
  • "awsRegions": [
    ],
  • "azureRegions": [
    ],
  • "billingProductID": "abc123",
  • "billingProviders": [
    ],
  • "byocOnpremRegions": [
    ],
  • "cloudProvidersConfigReadiness": {
    },
  • "customMetering": {
    },
  • "defaultBillingProvider": "STRIPE|BRING_YOUR_OWN",
  • "deploymentArtifactIDs": [
    ],
  • "deploymentConfiguration": {
    },
  • "description": "A premium product tier",
  • "disableInvoiceGeneration": false,
  • "documentation": "Any documentation",
  • "enableDeletionProtection": false,
  • "enabledFeatures": [
    ],
  • "exportUsageMetering": true,
  • "exportUsageMeteringConfig": {
    },
  • "features": {
    },
  • "gcpRegions": [
    ],
  • "id": "Impedit cumque rerum accusamus pariatur.",
  • "isDisabled": false,
  • "key": "premium",
  • "maxNumberOfInstances": 5,
  • "name": "Premium",
  • "nebiusRegions": [
    ],
  • "ociRegions": [
    ],
  • "onPremPlatforms": [
    ],
  • "planDescription": "A premium plan",
  • "pricePerUnit": {
    },
  • "pricing": {
    },
  • "privateRegions": [
    ],
  • "serviceId": "s-123456",
  • "serviceModelId": "Ex quidem possimus possimus velit consequuntur omnis.",
  • "support": "Any support",
  • "tierType": "OMNISTRATE_DEDICATED_TENANCY|OMNISTRATE_MULTI_TENANCY|CUSTOM_TENANCY"
}

UpdateProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
boolean

Allow creates when payment not configured

autoApproveSubscription
boolean

Auto approve subscription or not

awsRegions
Array of strings

The AWS regions that this product tier is available on

azureRegions
Array of strings

The Azure regions that this product tier is available on

billingProductID
string

Optional billing product ID for tax purposes

billingProviders
Array of strings

List of billing providers to be used for the product tier

byocOnpremRegions
Array of strings

The BYOC on-prem regions that this product tier is available on

object (CustomMeteringConfiguration)
defaultBillingProvider
string

The default billing provider to be used for the product tier

object (ProductTierDeploymentConfiguration)
description
string

A brief description of the product tier

disableInvoiceGeneration
boolean

Whether Stripe invoice generation is disabled for this product tier

documentation
string

Documentation

enableDeletionProtection
boolean

Enable deletion protection for the product tier

exportUsageMetering
boolean

Export usage metering data

object

Export usage metering data configuration

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.

maxNumberOfInstances
integer <int64>

Maximum number of instances. Set to -1 for unlimited.

name
string

Name of the product tier

nebiusRegions
Array of strings

The Nebius regions that this product tier is available on

ociRegions
Array of strings

The OCI regions that this product tier is available on

onPremPlatforms
Array of strings

The on prem platforms that this product tier is available on

planDescription
string

A brief description for the end user of the product tier

object

Price per unit.

pricing
any

Pricing

privateRegions
Array of strings

The private regions that this product tier is available on

support
string

Support

tierType
string

Tier type

Responses

Request samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "autoApproveSubscription": false,
  • "awsRegions": [
    ],
  • "azureRegions": [
    ],
  • "billingProductID": "abc123",
  • "billingProviders": [
    ],
  • "byocOnpremRegions": [
    ],
  • "customMetering": {
    },
  • "defaultBillingProvider": "STRIPE|BRING_YOUR_OWN",
  • "deploymentConfiguration": {
    },
  • "description": "A premium product tier",
  • "disableInvoiceGeneration": false,
  • "documentation": "Any documentation",
  • "enableDeletionProtection": false,
  • "exportUsageMetering": true,
  • "exportUsageMeteringConfig": {
    },
  • "gcpRegions": [
    ],
  • "isDisabled": false,
  • "maxNumberOfInstances": 5,
  • "name": "Premium",
  • "nebiusRegions": [
    ],
  • "ociRegions": [
    ],
  • "onPremPlatforms": [
    ],
  • "planDescription": "A premium plan",
  • "pricePerUnit": {
    },
  • "pricing": {
    },
  • "privateRegions": [
    ],
  • "support": "Any support",
  • "tierType": "OMNISTRATE_DEDICATED_TENANCY|OMNISTRATE_MULTI_TENANCY|CUSTOM_TENANCY"
}

DisableProductTierFeature product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

Request Body schema: application/json
required
feature
required
string

Feature to disable

scope
string

Feature scope

Responses

Request samples

Content type
application/json
{
  • "feature": "LOGS|METRICS|CLOUD_INSURANCE|MARKETPLACE|OPERATIONAL_STATUS|COMPLIANCE|APPLICATION_SECURITY",
  • "scope": "INTERNAL|CUSTOMER"
}

EnableProductTierFeature product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

Request Body schema: application/json
required
object

The configuration parameters of the product tier feature

feature
required
string

Feature to enable

scope
string

Feature scope

Responses

Request samples

Content type
application/json
{
  • "configuration": {
    },
  • "feature": "LOGS|METRICS|CLOUD_INSURANCE|MARKETPLACE|OPERATIONAL_STATUS|COMPLIANCE|APPLICATION_SECURITY",
  • "scope": "INTERNAL|CUSTOMER"
}

DescribeProductTierWorkspaceArtifacts product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

workspaceArtifactId
required
string
Example: ws-da-12345678

The workspace artifact archive ID

query Parameters
version
string
Example: version=3.0

The product tier version to use. If omitted, the latest product tier workspace artifacts are used.

Responses

Response samples

Content type
application/json
{
  • "lastFailedReason": "Failed to package deployment artifacts",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "workspaceArtifactId": "Consequuntur adipisci placeat et nesciunt temporibus dolores."
}

DownloadProductTierWorkspaceArtifacts product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

query Parameters
workspaceArtifactId
string
Example: workspaceArtifactId=ws-da-12345678

The workspace artifact archive ID to download. If omitted, the latest prepared workspace artifact archive is used.

version
string
Example: version=3.0

The product tier version to use. If omitted, the latest product tier workspace artifacts are used.

Responses

Response samples

Content type
application/json
"string"

GetProductTierWorkspaceArtifactsDownloadURL product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

query Parameters
workspaceArtifactId
string
Example: workspaceArtifactId=ws-da-12345678

The workspace artifact archive ID to download. If omitted, the latest prepared workspace artifact archive is used.

version
string
Example: version=3.0

The product tier version to use. If omitted, the latest product tier workspace artifacts are used.

Responses

Response samples

PrepareProductTierWorkspaceArtifacts product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

id
required
string
Example: pt-12345678

Product tier ID

query Parameters
version
string
Example: version=3.0

The product tier version to use. If omitted, the latest product tier workspace artifacts are used.

Responses

Response samples

Content type
application/json
{
  • "lastFailedReason": "Failed to package deployment artifacts",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "workspaceArtifactId": "Adipisci debitis voluptatem expedita laboriosam."
}

CopyProductTier product-tier-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID

sourceId
required
string
Example: pt-12345678

The source product tier ID

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
boolean

Allow creates when payment not configured

autoApproveSubscription
boolean

Auto approve subscription or not

awsRegions
Array of strings

The AWS regions that this product tier is available on

azureRegions
Array of strings

The Azure regions that this product tier is available on

billingProductID
string

Optional billing product ID for tax purposes

byocOnpremRegions
Array of strings

The BYOC on-prem regions that this product tier is available on

object (CustomMeteringConfiguration)
description
required
string

A brief description of the product tier

documentation
string

Documentation

enableDeletionProtection
boolean

Enable deletion protection for the product tier

exportUsageMetering
boolean

Export usage metering data

object

Export usage metering data configuration

gcpRegions
Array of strings

The GCP regions that this product tier is available on

maxNumberOfInstances
integer <int64>

Maximum number of instances

name
required
string

Name of the product tier

nebiusRegions
Array of strings

The Nebius regions that this product tier is available on

ociRegions
Array of strings

The OCI regions that this product tier is available on

onPremPlatforms
Array of strings

The on prem platforms that this product tier is available on

planDescription
string

A brief description for the end user of the product tier

object

Price per unit.

pricing
any

Pricing

privateRegions
Array of strings

The Private cloud regions that this product tier is available on

serviceModelId
required
string

Service model ID

support
string

Support

targetTierType
string

Tier type

Responses

Request samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "autoApproveSubscription": false,
  • "awsRegions": [
    ],
  • "azureRegions": [
    ],
  • "billingProductID": "abc123",
  • "byocOnpremRegions": [
    ],
  • "customMetering": {
    },
  • "description": "A premium product tier",
  • "documentation": "Any documentation",
  • "enableDeletionProtection": false,
  • "exportUsageMetering": true,
  • "exportUsageMeteringConfig": {
    },
  • "gcpRegions": [
    ],
  • "maxNumberOfInstances": 5,
  • "name": "Premium",
  • "nebiusRegions": [
    ],
  • "ociRegions": [
    ],
  • "onPremPlatforms": [
    ],
  • "planDescription": "A premium plan",
  • "pricePerUnit": {
    },
  • "pricing": {
    },
  • "privateRegions": [
    ],
  • "serviceModelId": "Vel exercitationem at praesentium libero nesciunt.",
  • "support": "Any support",
  • "targetTierType": "OMNISTRATE_DEDICATED_TENANCY|OMNISTRATE_MULTI_TENANCY|CUSTOM_TENANCY"
}

Response samples

Content type
application/json
"Est dignissimos est dolores impedit eligendi autem."

service-api-api

CreateServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
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

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-123456"
}

Response samples

Content type
application/json
"Et soluta ea nihil veritatis."

DeleteServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: sa-12345678

The service API ID

Responses

DescribeServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: sa-12345678

The service API ID

Responses

Response samples

Content type
application/json
{
  • "apiVersion": "v1",
  • "deploymentConfigId": "Et nisi cum vel ullam.",
  • "description": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
  • "id": "Dolores enim molestiae.",
  • "serviceEnvironmentId": "se-123456",
  • "serviceId": "s-123456",
  • "serviceName": "mysql"
}

UpdateServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
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
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: sa-12345678

The service API ID

query Parameters
productTierId
string
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
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: sa-12345678

The service API ID

query Parameters
productTierId
string
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": "Consequatur dolor.",
  • "resourceChangeSets": {
    },
  • "serviceId": "s-123456"
}

DeprecateServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: sa-12345678

The service API ID

Responses

ReleaseServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: sa-12345678

The service API ID

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

When true, copies the specification from the previous version during the release operation.

dryRun
boolean
Default: false

When true, performs a dry run of the release operation without making any actual changes to the current pending changes and the service API.

isPreferred
boolean
Default: false

Indicates whether this version set is preferred.

productTierId
string

The product tier ID

versionSetName
string

The name of the version set to release

versionSetType
string

The version-set type of the product-tier.

Responses

Request samples

Content type
application/json
{
  • "copySpecFromPreviousVersion": false,
  • "dryRun": false,
  • "isPreferred": true,
  • "productTierId": "Hic iusto id architecto quasi.",
  • "versionSetName": "v1",
  • "versionSetType": "Major|Incremental|UserDefined"
}

ListServiceAPI service-api-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

serviceEnvironmentId
required
string
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
Example: s-12345678

Service ID

serviceEnvironmentId
required
string
Example: se-12345678

Service environment ID

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

skipHasPendingChangesCheck
boolean
Example: skipHasPendingChangesCheck=false

Skip the check for pending changes in the service plans

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
Example: s-12345678

Service ID

productTierId
required
string
Example: pt-12345678

Product tier ID

Responses

Response samples

Content type
application/json
{
  • "AutoApproveSubscription": false,
  • "accountConfigIds": [
    ],
  • "activeAccountConfigIds": {
    },
  • "apiVersion": "v1",
  • "awsRegions": [
    ],
  • "azureRegions": [
    ],
  • "byocOnpremRegions": [
    ],
  • "deploymentConfigId": "Odio et.",
  • "gcpRegions": [
    ],
  • "hasPendingChanges": true,
  • "isProductTierDisabled": true,
  • "latestMajorVersion": "3.0",
  • "modelType": "OMNISTRATE_HOSTED|CUSTOMER_HOSTED|BYOA",
  • "nebiusRegions": [
    ],
  • "ociRegions": [
    ],
  • "onPremPlatforms": [
    ],
  • "privateRegions": [
    ],
  • "productTierDescription": "A premium product tier",
  • "productTierDocumentation": "Any documentation",
  • "productTierFeatures": {
    },
  • "productTierId": "Error vero culpa qui aperiam non occaecati.",
  • "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": "Temporibus earum tempora quisquam facere.",
  • "serviceEnvironmentId": "se-123456",
  • "serviceModelDescription": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
  • "serviceModelFeatures": [
    ],
  • "serviceModelId": "Officiis consectetur ut officiis maxime.",
  • "serviceModelName": "MySQL multi-writer service hosted model",
  • "tierType": "OMNISTRATE_DEDICATED_TENANCY|OMNISTRATE_MULTI_TENANCY|CUSTOM_TENANCY",
  • "versionSetStatus": "Preferred|Active|Deprecated|Pending"
}

resource-api

ListResources resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: si-12345678

The ID of the service to list resources for

productTierId
required
string
Example: pt-12345678

The product tier ID

query Parameters
managed
boolean
Example: managed=false

Is resource managed by omnistrate

ProductTierVersion
string
Example: ProductTierVersion=Eos maiores est quasi incidunt autem.

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
Example: s-12345678

The service ID that this API bundle belongs to

Request Body schema: application/json
required
object (AdditionalSecurityContext)
object (AgentConfiguration)
object (BackupConfiguration)
object (BlobStorageConfiguration)
object (ContainerImagesRegistryCopyConfiguration)
object

Custom labels for the resource

object

Custom sysctl settings for the resource

Array of objects (CustomULimits)

Custom ulimits for the resource

object (DeploymentTarget)

The deployment target configuration for the resource

description
required
string

A brief description of the resource

disable
string

Allows resource to be disabled. Expression returning true/false can be used as value. Resource is enabled by default, if this property is not set.

Array of objects (EnvironmentVariable)

The environment variables that this resource requires

object (FileSystemConfiguration)
object (HelmChartConfiguration)
imageConfigId
string

The ID of the image configuration that this resource refers to

infraConfigId
string

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

object (JobConfig)
key
string

The key of the resource

object (KustomizeConfiguration)
object (L4LoadBalancerConfiguration)
object (L7LoadBalancerConfiguration)
name
required
string

Name of the resource

object

The Terraform configurations for various OnPrem platforms

object (OperatorCRDConfiguration)
productTierId
required
string

The product tier ID

proxyType
string
Default: "PortsBasedProxy"

A proxy type of resource

Array of objects (ResourceDependency)
resourceType
string

The type of the resource

object

The Terraform configurations for various cloud providers

Responses

Request samples

Content type
application/json
{
  • "additionalSecurityContext": {
    },
  • "agentConfiguration": {
    },
  • "backupConfiguration": {
    },
  • "blobStorageConfiguration": {
    },
  • "containerImagesRegistryCopyConfiguration": {
    },
  • "customLabels": {
    },
  • "customSysCTLs": {
    },
  • "customULimits": [
    ],
  • "deploymentTarget": {
    },
  • "description": "A resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
  • "disable": "{{ $var.disableExtraComponents }}",
  • "environmentVariables": [
    ],
  • "fileSystemConfiguration": {
    },
  • "helmChartConfiguration": {
    },
  • "imageConfigId": "Quia sint atque animi.",
  • "infraConfigId": "Quasi repudiandae est et sint modi culpa.",
  • "internal": false,
  • "isProxy": false,
  • "jobConfig": {
    },
  • "key": "galera",
  • "kustomizeConfiguration": {
    },
  • "l4LoadBalancerConfiguration": {
    },
  • "l7LoadBalancerConfiguration": {
    },
  • "name": "Galera",
  • "onPremTerraformConfigurations": {
    },
  • "operatorCRDConfiguration": {
    },
  • "productTierId": "Maiores ducimus omnis minus.",
  • "proxyType": "PortsBasedProxy",
  • "resourceDependencies": [
    ],
  • "resourceType": "|Generic|PortsBasedProxy|L4LoadBalancer|L7LoadBalancer|FileSystem|OperatorCRD|HelmChart|Kustomize",
  • "terraformConfigurations": {
    }
}

Response samples

Content type
application/json
"Autem vero rerum labore."

DeleteResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

query Parameters
dryRun
boolean
Default: false
Example: dryRun=false

If true, validates the deletion without actually deleting the resource

Responses

DescribeResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Et magni quis occaecati qui id corrupti.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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

Responses

Response samples

Content type
application/json
{
  • "actionHooks": [
    ],
  • "additionalSecurityContext": {
    },
  • "agentConfiguration": {
    },
  • "backupConfiguration": {
    },
  • "blobStorageConfiguration": {
    },
  • "capabilities": [
    ],
  • "containerImagesRegistryCopyConfiguration": {
    },
  • "customLabels": {
    },
  • "customSysCTLs": {
    },
  • "customULimits": [
    ],
  • "dependencies": [
    ],
  • "deploymentTarget": {
    },
  • "description": "An resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
  • "disable": "{{ $var.disableExtraComponents }}",
  • "environmentVariables": [
    ],
  • "fileSystemConfiguration": {
    },
  • "helmChartConfiguration": {
    },
  • "id": "Nam officiis non.",
  • "imageConfigId": "Perspiciatis placeat sit.",
  • "infraConfigId": "Recusandae enim accusantium quia voluptas.",
  • "internal": true,
  • "isDeprecated": false,
  • "jobConfig": {
    },
  • "key": "galera",
  • "kustomizeConfiguration": {
    },
  • "l4LoadBalancerConfiguration": {
    },
  • "l7LoadBalancerConfiguration": {
    },
  • "name": "Galera",
  • "onPremTerraformConfigurations": {
    },
  • "operatorCRDConfiguration": {
    },
  • "productTierId": "Possimus est voluptatem quod vel sunt quia.",
  • "proxyType": "PortsBasedProxy",
  • "resourceType": "|Generic|PortsBasedProxy|L4LoadBalancer|L7LoadBalancer|FileSystem|OperatorCRD|HelmChart|Kustomize",
  • "serviceId": "s-123456",
  • "terraformConfigurations": {
    }
}

UpdateResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
object (AdditionalSecurityContext)
object (AgentConfiguration)
object (BackupConfiguration)
object (ContainerImagesRegistryCopyConfiguration)
object

Custom labels for the resource

object

Custom sysctl settings for the resource

Array of objects (CustomULimits)

Custom ulimits for the resource

Array of objects (ResourceDependency)
object (DeploymentTarget)

The deployment target configuration for the resource

description
string

A brief description of the resource

disable
string

Allows resource to be disabled. Expression returning true/false can be used as value. Resource is enabled by default, if this property is not set.

Array of objects (EnvironmentVariable)

The environment variables that this resource requires

object (FileSystemConfiguration)
object (HelmChartConfiguration)
imageConfigId
string

The ID of the image configuration that this resource refers to

infraConfigId
string

The ID of the infrastructure configuration that this resource refers to

object (JobConfig)
object (KustomizeConfiguration)
object (L4LoadBalancerConfiguration)
object (L7LoadBalancerConfiguration)
name
string

Name of the resource

object

The Terraform configurations for various OnPrem platforms

object (OperatorCRDConfiguration)
object

The Terraform configurations for various cloud providers

Responses

Request samples

Content type
application/json
{
  • "additionalSecurityContext": {
    },
  • "agentConfiguration": {
    },
  • "backupConfiguration": {
    },
  • "containerImagesRegistryCopyConfiguration": {
    },
  • "customLabels": {
    },
  • "customSysCTLs": {
    },
  • "customULimits": [
    ],
  • "dependencies": [
    ],
  • "deploymentTarget": {
    },
  • "description": "A resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
  • "disable": "{{ $var.disableExtraComponents }}",
  • "environmentVariables": [
    ],
  • "fileSystemConfiguration": {
    },
  • "helmChartConfiguration": {
    },
  • "imageConfigId": "Beatae fuga odit corporis qui nam quam.",
  • "infraConfigId": "Temporibus quos ab.",
  • "jobConfig": {
    },
  • "kustomizeConfiguration": {
    },
  • "l4LoadBalancerConfiguration": {
    },
  • "l7LoadBalancerConfiguration": {
    },
  • "name": "Galera",
  • "onPremTerraformConfigurations": {
    },
  • "operatorCRDConfiguration": {
    },
  • "terraformConfigurations": {
    }
}

DeregisterActionHook resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service to which the hook belongs

id
required
string
Example: r-12345678

The ID of the resource to which the hook belongs

Request Body schema: application/json
required
scope
required
string

The scope of the hook

type
required
string

The type of hook to execute

Responses

Request samples

Content type
application/json
{
  • "scope": "CLUSTER|NODE",
  • "type": "INIT|ADD|REMOVE|PROMOTE|DEMOTE|HEALTH_CHECK|READINESS_CHECK|STARTUP_CHECK|PRE_START|POST_START|PRE_UPGRADE|POST_UPGRADE|PRE_STOP|POST_STOP"
}

ListActionHooks resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service to which the hook belongs

id
required
string
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
Example: s-12345678

The ID of the service to which the hook belongs

id
required
string
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

customCommand
Array of strings

The custom command to execute the hook with

customImage
string

The custom image to execute the hook

scope
required
string

The scope of the hook

type
required
string

The type of hook to execute

Responses

Request samples

Content type
application/json
{
  • "commandTemplate": "ZWNobyAiaGVsbG8gd29ybGQi",
  • "customCommand": [
    ],
  • "customImage": "my-custom-image:latest",
  • "scope": "CLUSTER|NODE",
  • "type": "INIT|ADD|REMOVE|PROMOTE|DEMOTE|HEALTH_CHECK|READINESS_CHECK|STARTUP_CHECK|PRE_START|POST_START|PRE_UPGRADE|POST_UPGRADE|PRE_STOP|POST_STOP"
}

DisableResourceCapability resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
capability
required
string

The capability to disable

Responses

Request samples

Content type
application/json
{
  • "capability": "SERVERLESS|SERVICE_ACCOUNT_POLICIES|PROCESS_CORE_DUMP|CUSTOM_DNS|SIDECARS"
}

ListResourceCapabilities resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Soluta enim distinctio neque autem autem velit.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

Request Body schema: application/json
required
capability
required
string

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|SERVICE_ACCOUNT_POLICIES|PROCESS_CORE_DUMP|CUSTOM_DNS|SIDECARS",
  • "configuration": {
    }
}

ListDependentResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

Responses

Response samples

Content type
application/json
{
  • "id": "Cupiditate voluptate reiciendis.",
  • "ids": [
    ],
  • "nextPageToken": "next-token",
  • "serviceId": "s-123456"
}

DeprecateResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

Responses

UnsetEnvironmentVariables resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

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

The environment variables that this resource is no longer dependent on

Responses

Request samples

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

SetEnvironmentVariables resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
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": [
    ]
}

ListFiles resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

query Parameters
productTierId
string
Example: productTierId=pt-12345678

ProductTierId of the config file to describe

productTierVersion
string
Example: productTierVersion=1.0

Product tier version of the config file to describe. If missing, last version is described

Responses

Response samples

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

AddFile resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

header Parameters
Content-Type
stringmultipart/[^;]+; boundary=.+
Default: multipart/form-data; boundary=boundary
Example: multipart/form-data; boundary=boundary

Content-Type header, must define value for multipart boundary.

Name
required
string
Example: file.txt

The name of the file

Description
required
string
Example: A file to store the configuration for the resource

The description of the file

FileType
required
string
Example: Config

The type of the file

MountPath
required
string
Example: /etc/config

The mount path of the file

Responses

Response samples

Content type
application/json
"Optio voluptas sed nisi."

RemoveFile resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

fileId
required
string
Example: file-12345678

The ID of the file

Responses

GetFile resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

fileId
required
string
Example: f-12345678

The ID of the file

query Parameters
productTierId
string
Example: productTierId=pt-12345678

Product Tier ID of the config files to list

productTierVersion
string
Example: productTierVersion=1.0

Product Tier version of the config files to list. If missing, last version is used

Responses

Response samples

Content type
application/json
"string"

UpdateFileContent resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

fileId
required
string
Example: f-12345678

The ID of the file

header Parameters
Content-Type
stringmultipart/[^;]+; boundary=.+
Default: multipart/form-data; boundary=boundary
Example: multipart/form-data; boundary=boundary

Content-Type header, must define value for multipart boundary.

Responses

UpdateFileMetadata resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

fileId
required
string
Example: f-12345678

The ID of the file

Request Body schema: application/json
required
description
string

The description of the file

mountPath
string

The mount path of the file

name
string

The name of the file

Responses

Request samples

Content type
application/json
{
  • "description": "A file to store the configuration for the resource",
  • "mountPath": "/etc/config",
  • "name": "file.txt"
}

DeregisterResourceMetricsConfig resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

Responses

DescribeResourceMetricsConfig resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Omnis esse eveniet.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
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
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

resourceDependencyId
required
string
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
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

resourceDependencyId
required
string
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": {
    }
}

UndeprecateResource resource-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID that this API bundle belongs to

id
required
string
Example: r-12345678

The ID of the resource

Responses

custom-workflow-api

DeleteCustomWorkflow custom-workflow-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this workflow belongs to

id
required
string
Example: cwt-12345678

The custom workflow ID

Responses

DescribeCustomWorkflow custom-workflow-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this workflow belongs to

id
required
string
Example: cwt-12345678

The custom workflow ID

query Parameters
productTierVersion
string
Example: productTierVersion=Sunt provident nisi quas minus dolores.

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

productTierId
string
Example: productTierId=pt-12345678

Product tier ID of the workflow to describe. Needs to be specified in combination with the product tier version

Responses

Response samples

Content type
application/json
{
  • "apiParameters": [
    ],
  • "configuration": {
    },
  • "description": "Trigger an on-demand backup for the operator-managed service",
  • "id": "Molestias ipsum consectetur at et dolorem quia.",
  • "isSystemWorkflow": true,
  • "name": "Backup now",
  • "outputParameterSpecs": [
    ],
  • "outputParameters": {
    },
  • "productTierId": "Consequatur ut nulla et.",
  • "scope": [
    ],
  • "serviceId": "s-123456",
  • "spec": {
    },
  • "verb": "SWITCHOVER"
}

UpdateCustomWorkflow custom-workflow-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this workflow belongs to

id
required
string
Example: cwt-12345678

The custom workflow ID

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

The API parameters that users provide when invoking this workflow

object

Workflow-specific configuration as a flexible key-value map. For backup workflows: backupRetentionInDays (int), backupPeriodInHours (int), snapshotBeforeDeletion (bool). New properties can be added without API or schema changes.

description
string

A brief description of the workflow

name
string

The display name of the workflow

Array of objects (WorkflowOutputParameterSpec)

Typed declarations of the output parameters this workflow produces.

scope
Array of strings

The user context scopes that can invoke this workflow

spec
any

The workflow definition persisted for the service plan

verb
string

The workflow verb

Responses

Request samples

Content type
application/json
{
  • "apiParameters": [
    ],
  • "configuration": {
    },
  • "description": "Trigger an on-demand backup for the operator-managed service",
  • "name": "Backup now",
  • "outputParameterSpecs": [
    ],
  • "scope": [
    ],
  • "spec": {
    },
  • "verb": "SWITCHOVER"
}

ListCustomWorkflows custom-workflow-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that the workflows belong to

productTierId
required
string
Example: pt-12345678

The product tier ID

query Parameters
productTierVersion
string
Example: productTierVersion=Quae odit quis maiores saepe et est.

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

Responses

Response samples

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

CreateCustomWorkflow custom-workflow-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this workflow belongs to

productTierId
required
string
Example: pt-12345678

The product tier ID that this workflow belongs to

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

The API parameters that users provide when invoking this workflow

object

Workflow-specific configuration as a flexible key-value map. For backup workflows: backupRetentionInDays (int), backupPeriodInHours (int), snapshotBeforeDeletion (bool). New properties can be added without API or schema changes.

description
string

A brief description of the workflow

name
required
string

The display name of the workflow

Array of objects (WorkflowOutputParameterSpec)

Typed declarations of the output parameters this workflow produces.

scope
Array of strings

The user context scopes that can invoke this workflow

spec
required
any

The workflow definition persisted for the service plan

verb
required
string

The workflow verb

Responses

Request samples

Content type
application/json
{
  • "apiParameters": [
    ],
  • "configuration": {
    },
  • "description": "Trigger an on-demand backup for the operator-managed service",
  • "name": "Backup now",
  • "outputParameterSpecs": [
    ],
  • "scope": [
    ],
  • "spec": {
    },
  • "verb": "SWITCHOVER"
}

Response samples

Content type
application/json
"Qui quis excepturi."

tier-version-set-api

CustomerListTierVersionSets tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

The product tier ID that this version set belongs to.

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

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

ListTierVersionSets tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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.

excludeFeatures
boolean
Example: excludeFeatures=true

If true, omit the features and enabledFeatures fields from each version set.

excludeResources
boolean
Example: excludeResources=true

If true, omit the resources field from each version set.

excludeStats
boolean
Example: excludeStats=true

If true, omit runtime stats fields such as instanceCount from each version set.

nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

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
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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

The version-set type of the product-tier.

Responses

Request samples

Content type
application/json
{
  • "description": "Sapiente temporibus.",
  • "name": "Major version set",
  • "parentVersion": "2.0",
  • "type": "Major|Incremental|UserDefined"
}

Response samples

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

DescribeTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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",
  • "createBackupSystemWorkflowDisabled": true,
  • "createBackupSystemWorkflowDisabledAt": "2026-09-15T12:00:00Z",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "deleteBackupSystemWorkflowDisabled": true,
  • "deleteBackupSystemWorkflowDisabledAt": "2026-09-15T13:00:00Z",
  • "deploymentArtifactsVersionedMetadata": [
    ],
  • "description": "Et eaque recusandae provident officiis et quia.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "Porro vero blanditiis.",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Aspernatur corrupti rerum architecto fugit.",
  • "releaseNotes": "Culpa nostrum.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-123456",
  • "serviceModelId": "Dolor omnis qui omnis ut facere libero.",
  • "status": "Preferred|Active|Deprecated|Pending",
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

UpdateTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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
name
required
string

The name of the product-tier version set.

Responses

Request samples

Content type
application/json
{
  • "name": "Updated version set name"
}

Response samples

Content type
application/json
{
  • "autoApproveSubscription": false,
  • "baseVersion": "3.0",
  • "createBackupSystemWorkflowDisabled": true,
  • "createBackupSystemWorkflowDisabledAt": "2026-09-15T12:00:00Z",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "deleteBackupSystemWorkflowDisabled": true,
  • "deleteBackupSystemWorkflowDisabledAt": "2026-09-15T13:00:00Z",
  • "deploymentArtifactsVersionedMetadata": [
    ],
  • "description": "Beatae ea est.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "Consequuntur non sit.",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Et qui corrupti veritatis aliquam architecto.",
  • "releaseNotes": "Qui rerum expedita voluptas.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-123456",
  • "serviceModelId": "Eius unde sunt et doloremque ut eaque.",
  • "status": "Preferred|Active|Deprecated|Pending",
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

DeprecateTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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",
  • "createBackupSystemWorkflowDisabled": true,
  • "createBackupSystemWorkflowDisabledAt": "2026-09-15T12:00:00Z",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "deleteBackupSystemWorkflowDisabled": true,
  • "deleteBackupSystemWorkflowDisabledAt": "2026-09-15T13:00:00Z",
  • "deploymentArtifactsVersionedMetadata": [
    ],
  • "description": "Voluptatem earum distinctio nihil asperiores.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "Necessitatibus deleniti repellendus dolorem aliquam.",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Dolorem aut cum voluptatem.",
  • "releaseNotes": "Laboriosam eius omnis ipsa sed soluta.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-123456",
  • "serviceModelId": "Est omnis dolore vitae enim saepe sit.",
  • "status": "Preferred|Active|Deprecated|Pending",
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

DiffTierVersionSets tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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": "Ratione cumque possimus est aliquid et est.",
  • "resourceChangeSets": {
    },
  • "serviceId": "s-123456",
  • "version": "3.0"
}

DescribeTierVersionSetMetadata tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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
{
  • "createBackupSystemWorkflowDisabled": true,
  • "createBackupSystemWorkflowDisabledAt": "2026-09-15T12:00:00Z",
  • "deleteBackupSystemWorkflowDisabled": true,
  • "deleteBackupSystemWorkflowDisabledAt": "2026-09-15T13:00:00Z",
  • "productTierId": "Aut consequuntur ducimus ea optio eos.",
  • "releaseNotes": "Reprehenderit sequi.",
  • "serviceId": "s-123456",
  • "version": "Ullam dolores vero perspiciatis molestiae aperiam."
}

UpdateTierVersionSetMetadata tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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
releaseNotes
string

Release notes for the version set.

Responses

Request samples

Content type
application/json
{
  • "releaseNotes": "Repudiandae vel ut."
}

Response samples

Content type
application/json
{
  • "createBackupSystemWorkflowDisabled": true,
  • "createBackupSystemWorkflowDisabledAt": "2026-09-15T12:00:00Z",
  • "deleteBackupSystemWorkflowDisabled": true,
  • "deleteBackupSystemWorkflowDisabledAt": "2026-09-15T13:00:00Z",
  • "productTierId": "In similique nesciunt nihil.",
  • "releaseNotes": "Dolorem quam.",
  • "serviceId": "s-123456",
  • "version": "Corporis nihil delectus eum."
}

PromoteTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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",
  • "createBackupSystemWorkflowDisabled": true,
  • "createBackupSystemWorkflowDisabledAt": "2026-09-15T12:00:00Z",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "deleteBackupSystemWorkflowDisabled": true,
  • "deleteBackupSystemWorkflowDisabledAt": "2026-09-15T13:00:00Z",
  • "deploymentArtifactsVersionedMetadata": [
    ],
  • "description": "Odio voluptatem fugiat laboriosam odit consequatur voluptates.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "Et sint sit cum.",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Alias quia non laudantium.",
  • "releaseNotes": "Neque non ratione nam reiciendis odit.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-123456",
  • "serviceModelId": "Dolores impedit ducimus nostrum nemo repudiandae.",
  • "status": "Preferred|Active|Deprecated|Pending",
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

ReleaseTierVersionSet tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

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",
  • "createBackupSystemWorkflowDisabled": true,
  • "createBackupSystemWorkflowDisabledAt": "2026-09-15T12:00:00Z",
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "deleteBackupSystemWorkflowDisabled": true,
  • "deleteBackupSystemWorkflowDisabledAt": "2026-09-15T13:00:00Z",
  • "deploymentArtifactsVersionedMetadata": [
    ],
  • "description": "Distinctio sed officia deleniti saepe ut.",
  • "enabledFeatures": [
    ],
  • "features": {
    },
  • "instanceCount": 12,
  • "latestUpgradePathId": "Ut aperiam velit.",
  • "name": "Regular version set",
  • "parentVersion": "2.0",
  • "productTierId": "Cupiditate quo.",
  • "releaseNotes": "Rerum in corporis.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "releasedBy": "John Doe",
  • "resources": [
    ],
  • "serviceId": "s-123456",
  • "serviceModelId": "Ipsum dolore consequuntur et fugit.",
  • "status": "Preferred|Active|Deprecated|Pending",
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "version": "3.0"
}

GetTierVersionSetSpec tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

The product tier ID that this version set belongs to.

query Parameters
version
string
Example: version=3.0

The version number for the specific version set. If not specified, returns the latest preferred or active version.

Responses

Response samples

Content type
application/json
{
  • "createdAt": "1996-02-03T15:29:06Z",
  • "productTierId": "Non ea sunt non illum ea.",
  • "serviceId": "s-123456",
  • "specContent": "{\"RawYAML\":\"bmFtZTogbXktc2VydmljZQpkZXBsb3ltZW50OgogIGhvc3RlZDoKICAgIGFjY291bnQ6IC4uLg==\",\"Configs\":{\"database_url\":\"cG9zdGdyZXM6Ly9sb2NhbGhvc3Q6NTQzMi9teWRi\"},\"Secrets\":{\"api_key\":\"c2VjcmV0X2FwaV9rZXlfdjEyMzQ1\"}}",
  • "updatedAt": "1975-08-20T16:59:33Z",
  • "version": "1.0"
}

ListTierVersionSetSpecs tier-version-set-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

ID of the Service

productTierId
required
string
Example: Ad a officiis est nobis debitis eos.

The product tier ID that this version set belongs to.

Responses

Response samples

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

input-parameter-api

CreateInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
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

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

A map for labeled options. The key is the label and the value is the option. When the option is selected, the label will be displayed to the end customer. Specify either options or labeledOptions when defining 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)

regex
string

Regular expression pattern for validating the input parameter value

required
required
boolean

Enforces the input parameter as a required parameter

resourceId
required
string

The ID of the resource that this input parameter belongs to

object (InputParameterScope)

Scope of the input parameter

tabIndex
integer <int64>
Default: 0

Index for parameter ordering in the SaaS portal

type
required
string

Responses

Request samples

Content type
application/json
{
  • "defaultValue": "default value",
  • "dependentResourceId": "Libero maxime aperiam.",
  • "description": "Similique suscipit.",
  • "hasOptions": true,
  • "isList": false,
  • "key": "g5",
  • "labeledOptions": {
    },
  • "limits": {
    },
  • "modifiable": true,
  • "name": "f",
  • "options": [
    ],
  • "regex": "^[a-zA-Z0-9_-]+$",
  • "required": true,
  • "resourceId": "Facilis doloremque.",
  • "scope": {
    },
  • "tabIndex": 1,
  • "type": "Boolean|Float64|String|Resource|Secret|Password"
}

Response samples

Content type
application/json
"Odio enim vitae."

DeleteInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string
Example: var-12345678

ID of the input parameter

Responses

DescribeInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string
Example: var-12345678

ID of the input parameter

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Molestias impedit optio exercitationem quam aut cupiditate.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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": "Minus totam.",
  • "description": "Aut voluptates quisquam sit.",
  • "hasOptions": false,
  • "id": "Qui unde quaerat saepe optio et.",
  • "isList": false,
  • "key": "4o",
  • "labeledOptions": {
    },
  • "limits": {
    },
  • "modifiable": true,
  • "name": "60a",
  • "options": [
    ],
  • "regex": "^[a-zA-Z0-9_-]+$",
  • "required": true,
  • "resourceId": "Quas illum culpa.",
  • "scope": {
    },
  • "serviceId": "s-123456",
  • "tabIndex": 1,
  • "type": "Boolean|Float64|String|Resource|Secret|Password"
}

UpdateInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string
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

A map for labeled options. The key is the label and the value is the option. When the option is selected, the label will be displayed to the end customer. Specify either options or labeledOptions when defining the input parameter.

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)

regex
string

Regular expression pattern for validating the input parameter value

required
boolean

Enforces the input parameter as a required parameter

object (InputParameterScope)

Scope of the input parameter

tabIndex
integer <int64>
Default: 0

Index for parameter ordering in the SaaS portal

Responses

Request samples

Content type
application/json
{
  • "defaultValue": "[\"1\", \"2.8\", \"3\"]",
  • "description": "Magni ea dolorum voluptate.",
  • "hasOptions": true,
  • "labeledOptions": {
    },
  • "limits": {
    },
  • "modifiable": false,
  • "name": "iy",
  • "options": [
    ],
  • "regex": "^[0-9]+$",
  • "required": false,
  • "scope": {
    },
  • "tabIndex": 1
}

ListInputParameter input-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this output parameter belongs to

resourceId
required
string
Example: r-12345678

The ID of the resource that this input parameter belongs to

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Sunt ab ut.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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
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

object (GenericCommandValueProviderConfig)

Configuration for generic command-based value provider

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

Key of the output variable being exported

object (KubectlValueProviderConfig)

Configuration for kubectl-based value provider

name
required
string non-empty

External name of the output variable being exported

resourceId
required
string

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

Responses

Request samples

Content type
application/json
{
  • "description": "Username of the user created in the target system",
  • "genericCommandValueProvider": {
    },
  • "key": "username",
  • "kubectlValueProvider": {
    },
  • "name": "Username",
  • "resourceId": "Ratione sed odit ullam.",
  • "value": "johndoe",
  • "valueRef": "$var.username",
  • "valueType": "Boolean|Float64|String|Secret|Password"
}

Response samples

Content type
application/json
"Dolorum dolorum sapiente inventore optio."

DeleteOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string
Example: op-12345678

The ID of the output parameter

Responses

DescribeOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string
Example: op-12345678

The ID of the output parameter

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Vero quam enim asperiores.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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",
  • "genericCommandValueProvider": {
    },
  • "id": "Quas voluptatem ea esse aut.",
  • "key": "username",
  • "kubectlValueProvider": {
    },
  • "name": "Username",
  • "resourceId": "Fuga aliquam dicta ut.",
  • "serviceId": "s-123456",
  • "value": "johndoe",
  • "valueRef": "$var.username",
  • "valueType": "Boolean|Float64|String|Secret|Password"
}

UpdateOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this output parameter belongs to

id
required
string
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

object (GenericCommandValueProviderConfig)

Configuration for generic command-based value provider

object (KubectlValueProviderConfig)

Configuration for kubectl-based value provider

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

Responses

Request samples

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

ListOutputParameter output-parameter-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service that this output parameter belongs to

resourceId
required
string
Example: r-12345678

The ID of the resource that this output parameter belongs to

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Voluptas accusantium commodi.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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
Example: s-12345678

Service ID for the VUnit

serviceModelId
required
string
Example: sm-12345678

Service Model ID for the VUnit

Request Body schema: application/json
required
cloudProvider
required
string

The infra / cloud provider name

region
required
string

Region code specific to the cloud-provider

Responses

Request samples

Content type
application/json
{
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "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
Example: s-12345678

Service ID context

id
required
string
Example: n-12345678

Network to operate on

Responses

Response samples

Content type
application/json
{
  • "cidr": "10.0.0.0/16",
  • "id": "Quia ut dolore dolores magnam provident minima.",
  • "networkConfigId": "Est aut soluta quia debitis.",
  • "serviceId": "s-123456",
  • "type": "PUBLIC",
  • "vunitId": "Tempora sed quis."
}

DescribeVUnit vunit-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

Service ID for the VUnit

id
required
string
Example: vu-12345678

VUnit to operate on

Responses

Response samples

Content type
application/json
{
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "id": "Facilis nemo labore aliquid repudiandae amet molestiae.",
  • "networkIds": [
    ],
  • "region": "us-west-2",
  • "serviceId": "s-123456",
  • "serviceModelId": "Provident temporibus deleniti tempore."
}

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
Example: s-12345678

The service ID

Request Body schema: application/json
required
computeConfigId
string

The compute config ID

object (CustomTag)

Custom tag

description
required
string

The description for the infra config

name
required
string

The name of the infra config

networkConfigId
string

The network config ID

serviceEnvironmentId
required
string

The service environment ID

storageConfigId
string

The storage config ID

Responses

Request samples

Content type
application/json
{
  • "computeConfigId": "Voluptatibus ad id laborum deserunt veritatis.",
  • "customTag": {
    },
  • "description": "Infra config used for the base tier MySQL service",
  • "name": "MySQL Writer Infra Config",
  • "networkConfigId": "Dignissimos non non necessitatibus accusantium voluptas.",
  • "serviceEnvironmentId": "se-123456",
  • "storageConfigId": "Reprehenderit recusandae dolorem consequatur est tempora non."
}

Response samples

Content type
application/json
"Doloribus qui."

DeleteInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Responses

DescribeInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Vel vitae.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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": "Voluptatibus quia natus.",
  • "customTag": {
    },
  • "description": "Infra config used for the base tier MySQL service",
  • "id": "Eum atque doloremque quia consequatur.",
  • "name": "MySQL Writer Infra Config",
  • "networkConfigId": "Rerum consequatur nemo amet id est quam.",
  • "serviceEnvironmentId": "se-123456",
  • "serviceId": "s-123456",
  • "storageConfigId": "Saepe est amet aut fugiat."
}

UpdateInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Request Body schema: application/json
required
computeConfigId
string

The compute config ID

object (CustomTag)

Custom tag

description
string

The description for the infra config

name
string

The name of the infra config

networkConfigId
string

The network config ID

storageConfigId
string

The storage config ID per compute node

Responses

Request samples

Content type
application/json
{
  • "computeConfigId": "Quod molestias numquam quibusdam quas dolorem corporis.",
  • "customTag": {
    },
  • "description": "Infra config used for the base tier MySQL service",
  • "name": "MySQL Writer Infra Config",
  • "networkConfigId": "Voluptatem ut alias quia odit a.",
  • "storageConfigId": "Dolor earum ut."
}

ListAssociatedResources infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Responses

Response samples

Content type
application/json
{
  • "id": "Quasi assumenda aut ullam nostrum.",
  • "resourceIds": [
    ],
  • "serviceId": "s-123456"
}

DetachComputeConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Responses

DetachNetworkConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Responses

ReleaseInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Request Body schema: application/json
required
productTierId
string

The product tier ID

Responses

Request samples

Content type
application/json
{
  • "productTierId": "Voluptatibus maiores suscipit ut ducimus nemo est."
}

RolloutFleetInfra infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Responses

RolloutFleetInfraStatus infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Responses

Response samples

Content type
application/json
{
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING"
}

DetachStorageConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: ic-12345678

Infra Config ID to operate on

Responses

ListInfraConfig infra-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

serviceEnvironmentId
required
string
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
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

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

The service environment ID

Responses

Request samples

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

Response samples

Content type
application/json
"Provident et voluptatem repellendus consequatur praesentium vero."

DeleteImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: imgc-12345678

The image configuration ID

Responses

DescribeImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: imgc-12345678

The image configuration ID

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Vero iure neque dolore quasi.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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": "Laborum et aliquam ipsam praesentium.",
  • "imageName": "mysql",
  • "imageRegistryId": "Commodi voluptate quia.",
  • "imageSignaturePublicKeyPEM": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
  • "imageTag": "v1",
  • "serviceEnvironmentId": "se-123456",
  • "serviceId": "s-123456"
}

UpdateImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
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

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": "Autem similique.",
  • "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
Example: s-12345678

The service ID

id
required
string
Example: imgc-12345678

The image configuration ID

Request Body schema: application/json
required
productTierId
string

The product tier ID

Responses

Request samples

Content type
application/json
{
  • "productTierId": "Neque provident delectus voluptatum."
}

RolloutFleetImageStatus image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: imgc-12345678

The image configuration ID

Responses

Response samples

Content type
application/json
{
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING"
}

RolloutFleetImageConfig image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: imgc-12345678

The image configuration ID

Responses

ListImageConfigs image-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID to use for the infra

serviceEnvironmentId
required
string
Example: se-12345678

The service environment ID

Responses

Response samples

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

deployment-artifact-api

The deployment artifact API manages the deployment artifacts for Omnistrate entities

UploadDeploymentArtifact deployment-artifact-api

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

The account config ID associated with the deployment artifact

artifactPath
required
string

The path to the deployment artifact

base64EncodedArtifact
required
string

The deployment artifact file content with base64 encoding, and expected to be a .tar.gz file

environmentType
required
string

The environment type for the deployment artifact

productTierName
required
string

The name of the product tier

serviceName
required
string

The name of the service

Responses

Request samples

Content type
application/json
{
  • "accountConfigID": "ac-1234567890",
  • "artifactPath": "/path/to",
  • "base64EncodedArtifact": "Voluptas ut.",
  • "environmentType": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "productTierName": "standard",
  • "serviceName": "my-service"
}

Response samples

Content type
application/json
"Blanditiis at architecto beatae saepe a."

DescribeDeploymentArtifact deployment-artifact-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: da-12345678

The ID of the deployment artifact

query Parameters
hash
string
Example: hash=3a7bd3e2360a3d4855f3c8d2f8f6e6c1

Hash of the deployment artifact to describe. If not specified, the latest version is described.

Responses

Response samples

Content type
application/json
{
  • "accountConfigID": "Aut aspernatur delectus minus.",
  • "artifactPath": "artifacts/path/to/",
  • "hash": "3a7bd3e2360a3d4855f3c8d2f8f6e6c1",
  • "id": "Quis libero.",
  • "lastFailedReason": "Failed",
  • "presignedDownloadUrl": "https://api.omnistrate.cloud/2022-09-01-00/deployment-artifact/da-12345678/download",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED"
}

DownloadDeploymentArtifact deployment-artifact-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: da-12345678

The ID of the deployment artifact

query Parameters
hash
string
Example: hash=3a7bd3e2360a3d4855f3c8d2f8f6e6c1

Hash of the deployment artifact to download. If not specified, the latest version is downloaded.

Responses

Response samples

Content type
application/json
"string"

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

Responses

Request samples

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

Response samples

Content type
application/json
"Ut consequuntur sint soluta."

DeleteDeploymentConfig deployment-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
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": "Quo reprehenderit aut ullam.",
  • "infraRollConfiguration": {
    },
  • "name": "Production",
  • "rolloutPriorityList": [
    ]
}

UpdateDeploymentConfig deployment-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
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

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
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
Example: s-12345678

The service ID

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

Autoscaling policy for compute nodes

cpuArchitecture
string

Processor architecture

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": {
    },
  • "cpuArchitecture": "X86_64|ARM64",
  • "description": "my compute config description",
  • "name": "my compute config",
  • "replicaCount": "3",
  • "resources": {
    },
  • "rootVolumeSizeGi": 10,
  • "warmPoolConfiguration": {
    }
}

Response samples

Content type
application/json
"Qui omnis neque."

DeleteComputeConfig compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: cc-12345678

ID of the compute config

Responses

DescribeComputeConfig compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: cc-12345678

ID of the compute config

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Vel animi officiis ratione doloribus.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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": {
    },
  • "computeInstanceTypeConfigOverrides": {
    },
  • "cpuArchitecture": "X86_64|ARM64",
  • "description": "my compute config description",
  • "id": "Perspiciatis ipsa.",
  • "infraConfigIDs": [
    ],
  • "instanceTypes": {
    },
  • "name": "my compute config",
  • "replicaCount": "3",
  • "resources": {
    },
  • "rootVolumeSizeGi": 10,
  • "serviceId": "s-123456",
  • "warmPoolConfiguration": {
    }
}

UpdateComputeConfig compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: cc-12345678

ID of the compute config

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

Autoscaling policy for compute nodes

cpuArchitecture
string

Processor architecture

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": {
    },
  • "cpuArchitecture": "X86_64|ARM64",
  • "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
Example: s-12345678

The service ID

id
required
string
Example: cc-12345678

ID of the compute config

Request Body schema: application/json
required
cloudProviderName
required
string

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|azure|gcp|nebius|oci|byoc-onprem|all",
  • "instanceType": "t3.micro"
}

AddComputeInstanceType compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: cc-12345678

ID of the compute config

Request Body schema: application/json
required
cloudProviderName
required
string

The cloud provider for this compute instance type config

object (ComputeInstanceTypeConfigOverride)
instanceType
required
string

The instance type for this compute instance type config

Responses

Request samples

Content type
application/json
{
  • "cloudProviderName": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "configOverride": {
    },
  • "instanceType": "t3.micro"
}

ListComputeInstanceTypes compute-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

cloudProviderName
required
string
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
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
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
"Eaque velit illo atque et."

DeleteStorageConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: sc-12345678

The storage config ID

Responses

DescribeStorageConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: sc-12345678

The storage config ID

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Ducimus et et autem.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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": "Fugit ex illo.",
  • "infraConfigIDs": [
    ],
  • "name": "my-storage-config",
  • "serviceId": "s-123456",
  • "volumes": {
    }
}

UpdateStorageConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: sc-12345678

The storage config ID

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

Description of the storage config

name
string non-empty

Name of the storage config

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
Example: s-12345678

The service ID

id
required
string
Example: sc-12345678

The storage config ID

storageVolumeConfigId
required
string
Example: svc-12345678

The storage volume config ID

Request Body schema: application/json
required
mountPath
string

The specific mount path to remove. If not specified, all mount paths for the storage volume config will be removed

Responses

Request samples

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

AddStorageVolumeConfig storage-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: sc-12345678

The storage config ID

storageVolumeConfigId
required
string
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
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
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

disableBackup
boolean

Disable backup for the storage volume

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

storageResourceID
string

The storage resource ID

Responses

Request samples

Content type
application/json
{
  • "clusterStorageType": "S3|$var.storageType|AWS::EFS",
  • "description": "A storage volume set to store the MySQL data directory",
  • "disableBackup": false,
  • "instanceStorageIops": "$var.storageIops",
  • "instanceStorageSizeGi": "$var.storage_size",
  • "instanceStorageThroughputMiBps": "128",
  • "instanceStorageType": "$var.storageType",
  • "name": "MySQL Data Volume",
  • "storageResourceID": "r-12345678"
}

Response samples

Content type
application/json
"Aut non modi quasi alias illo consequatur."

DeleteStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: svc-12345678

The storage volume config ID

Responses

DescribeStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: svc-12345678

The storage volume config ID

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Beatae quaerat veniam ipsum neque ut vero.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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|azure|gcp|nebius|oci|byoc-onprem|all",
  • "clusterStorageType": "S3|$var.storageType|AWS::EFS",
  • "description": "A storage volume set to store the MySQL data directory",
  • "disableBackup": false,
  • "id": "Sint qui.",
  • "instanceStorageIops": "7500",
  • "instanceStorageSizeGi": "128",
  • "instanceStorageThroughputMiBps": "128",
  • "instanceStorageType": "$var.storageType",
  • "name": "MySQL Data Volume",
  • "serviceId": "s-123456",
  • "storageResourceID": "r-12345678"
}

UpdateStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
Example: svc-12345678

The storage volume config ID

Request Body schema: application/json
required
description
string

A brief description of the context for the storage volume pool

disableBackup
boolean

Disable backup for the storage volume

name
string

Name of the storage volume pool

Responses

Request samples

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

UpdateInstanceStorageVolumeConfig storage-volume-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The service ID

id
required
string
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
Example: s-12345678

The service ID

id
required
string
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
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
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

object

Named ports to map to the generated DNS endpoint

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

Ports to map to the generated DNS endpoint

object (PrivateNetworkingConfiguration)

The private networking configuration for the network config

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

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",
  • "namedOpenPorts": {
    },
  • "openPorts": [
    ],
  • "privateNetworkingConfiguration": {
    },
  • "publicNetworkingConfiguration": {
    },
  • "stableEgressIP": true,
  • "tlsTerminationPort": 443,
  • "zoneConfiguration": "SINGLE_ZONE_OMNISTRATE_RECOMMENDED|SINGLE_ZONE_CUSTOMER_PROVIDED|MULTI_ZONE"
}

Response samples

Content type
application/json
"Praesentium ut aut dolores dicta adipisci."

DeleteNetworkConfig network-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service

id
required
string
Example: nc-12345678

The ID of the network config

Responses

DescribeNetworkConfig network-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service

id
required
string
Example: nc-12345678

The ID of the network config

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Molestiae quia qui ab quos quia.

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

ProductTierId
string
Example: ProductTierId=Ad a officiis est nobis debitis eos.

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": "Est natus debitis quisquam reiciendis adipisci eligendi.",
  • "infraConfigIDs": [
    ],
  • "internal": true,
  • "name": "Multi-zone",
  • "namedOpenPorts": {
    },
  • "openPorts": [
    ],
  • "privateNetworkingConfiguration": {
    },
  • "publicNetworkingConfiguration": {
    },
  • "serviceId": "s-123456",
  • "stableEgressIP": true,
  • "tlsTerminationPort": 443,
  • "zoneConfiguration": "SINGLE_ZONE_OMNISTRATE_RECOMMENDED|SINGLE_ZONE_CUSTOMER_PROVIDED|MULTI_ZONE"
}

UpdateNetworkConfig network-config-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceId
required
string
Example: s-12345678

The ID of the service

id
required
string
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

object

Named ports to map to the generated DNS endpoint

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

Ports to map to the generated DNS endpoint

object (PrivateNetworkingConfiguration)

The private networking configuration for the network config

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

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",
  • "namedOpenPorts": {
    },
  • "openPorts": [
    ],
  • "privateNetworkingConfiguration": {
    },
  • "publicNetworkingConfiguration": {
    },
  • "stableEgressIP": true,
  • "tlsTerminationPort": 443,
  • "zoneConfiguration": "SINGLE_ZONE_OMNISTRATE_RECOMMENDED|SINGLE_ZONE_CUSTOMER_PROVIDED|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
Example: az-12345678

ID of an AZ

Responses

Response samples

Content type
application/json
{
  • "cloudProviderName": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "code": "us-east-1a",
  • "description": "US East (N. Virginia) Availability Zone A",
  • "id": "Deserunt cupiditate qui et ut officiis.",
  • "regionCode": "us-east-1"
}

ListAvailabilityZone availability-zone-api

Authorizations:
api_key_header_Authorization
path Parameters
cloudProviderName
required
string
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
Example: aws

The cloud provider for this compute instance type config

Responses

Response samples

Content type
application/json
"Et ut."

ListAvailabilityZonesByRegionCode availability-zone-api

Authorizations:
api_key_header_Authorization
path Parameters
regionCode
required
string
Example: us-east-1
cloudProviderName
required
string
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
Example: region-12345678

ID of the Region

Responses

Response samples

Content type
application/json
{
  • "cloudProviderId": "Recusandae aliquid assumenda.",
  • "cloudProviderName": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "code": "us-east-1",
  • "description": "US East (N. Virginia)",
  • "id": "Voluptatem atque cum incidunt est quidem."
}

ListRegion region-api

Authorizations:
api_key_header_Authorization
path Parameters
cloudProviderName
required
string
Example: aws

The cloud provider for this compute instance type config

query Parameters
serviceId
string
Example: serviceId=s-12345678

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

serviceModelId
string
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
Example: productTierId=pt-12345678

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

modelType
string
Example: modelType=CUSTOMER_HOSTED

Model type. If specified, list regions for the specified model type.

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
Example: aws

The cloud provider for this compute instance type config

Responses

Response samples

Content type
application/json
"Est rerum."

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
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
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
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
Example: infra-12345678

ID of the CloudProvider

Responses

Response samples

Content type
application/json
{
  • "description": "Amazon Web Services",
  • "id": "At reiciendis facilis atque est esse aperiam.",
  • "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
"Aut velit aspernatur."

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
{
  • "company": "ABC",
  • "email": "abc@gmail.com",
  • "name": "John Doe",
  • "phone": "+1-234567890"
}

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": "abc@gmail.com",
  • "message": "this is a test",
  • "name": "John Doe"
}

signin-api

The signin API for customers to authenticate with us

LoginWithIdentityProvider signin-api

Request Body schema: application/json
required
object

Additional attributes for the user

authorizationCode
string

The authorization code from the Identity Provider

companyDescription
string non-empty
companyUrl
string non-empty
deviceCode
string

The device code from the Identity Provider

identityProviderName
required
string

The name of the identity provider

invitedEmail
string <email>

Email address that the user was invited with

legalCompanyName
string non-empty
redirectUri
string

The redirect URI used to get the authorization code

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "authorizationCode": "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&",
  • "companyDescription": "We sell xyz database software",
  • "companyUrl": "https://www.mywebsite.com",
  • "deviceCode": "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&",
  • "identityProviderName": "Google|GitHub|Microsoft Entra|Amazon Cognito|Okta|Auth0|Keycloak|OIDC",
  • "invitedEmail": "abc@gmail.com",
  • "legalCompanyName": "mywebsite",
  • "redirectUri": "https://www.example/redirect"
}

Response samples

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

RefreshToken signin-api

Exchange a valid refresh token for a new JWT token and refresh token pair

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

The refresh token to exchange for a new JWT token. Optional when the refresh token is provided via httpOnly cookie.

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "l7"
}

Response samples

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

RevokeToken signin-api

Revoke a single refresh token, preventing further JWT renewal from that session. The access JWT continues until its natural TTL expiry. Idempotent: revoking an unknown or already-revoked token returns success.

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

The refresh token to revoke. Optional when the refresh token is provided via httpOnly cookie.

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "oq3"
}

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
{
  • "email": "abc@gmail.com",
  • "hashedPassword": "deprecated",
  • "password": "password"
}

Response samples

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

sp-organization-api

The Organization API for managing service provider organizations

GetCustomMetricsEndpoint sp-organization-api

Returns the custom metrics endpoint and an access token scoped to the authenticated organization.

Authorizations:
api_key_header_Authorization
query Parameters
expiresInSeconds
integer <int64> >= 1
Example: expiresInSeconds=86400

Optional lifetime in seconds for the access token. It cannot exceed the configured maximum validity.

Responses

Response samples

Content type
application/json
{}

DescribeServiceProviderOrganization sp-organization-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "DefaultDeploymentCellConfigurations": {
    },
  • "DeploymentCellConfigurationsPerEnv": {
    },
  • "id": "Dolorem itaque.",
  • "isPerEnvClusterEnabled": true
}

ModifyServiceProviderOrganization sp-organization-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
object

The default deployment cell configurations for the organization per environment.

Responses

Request samples

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

GetServiceProviderConfigurationForEnvironment sp-organization-api

Returns the service provider deployment cell configuration and account statuses for an environment

Authorizations:
api_key_header_Authorization
path Parameters
environmentName
required
string non-empty
Example: Production

The name of the environment whose service provider configuration should be returned

Responses

Response samples

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

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": "abc@gmail.com",
  • "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
{
  • "email": "abc@gmail.com"
}

Signup signup-api

Request Body schema: application/json
required
object

Additional attributes for the user signup

companyDescription
string non-empty
companyUrl
string non-empty
email
required
string <email> non-empty
legalCompanyName
string
Default: ""
name
required
string non-empty
password
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "companyDescription": "We sell xyz database software",
  • "companyUrl": "https://www.mywebsite.com",
  • "email": "abc@gmail.com",
  • "legalCompanyName": "mywebsite",
  • "name": "John Doe",
  • "password": "password"
}

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
{
  • "email": "abc@gmail.com",
  • "token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6"
}

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",
  • "paymentConfigured": true,
  • "paymentInfoPortalURL": "https://billing.stripe.com/p/session/abc123",
  • "planCoreHourCost": 0.05,
  • "planDescription": "The starter plan is priced at 'X' units",
  • "planFrequency": "MONTHLY",
  • "planMonthlyCost": 49,
  • "planName": "STARTER_NO_COMMIT|STARTER|GROWTH|ENTERPRISE",
  • "startDate": "2023-01-01"
}

ChangePlan plan-api

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

The name of the plan this user is changing to

Responses

Request samples

Content type
application/json
{
  • "planName": "STARTER_NO_COMMIT|STARTER|GROWTH|ENTERPRISE"
}

usage-api

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

GetCurrentUsage usage-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

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

GetUsagePerDay usage-api

Authorizations:
api_key_header_Authorization
query Parameters
startDate
string <date-time>
Example: startDate=2023-01-01T10:00:00Z

Start date of the usage report

endDate
string <date-time>
Example: endDate=2024-01-01T10:00:00Z

End date of the usage report

Responses

Response samples

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

invoice-api

The Invoices API gets the list of invoices for the organization

ListInvoices invoice-api

Authorizations:
api_key_header_Authorization
query Parameters
billingProvider
string
Example: billingProvider=STRIPE

Billing provider. If specified, list invoices for the specified billing provider.

Responses

Response samples

Content type
application/json
{}

DescribeInvoice invoice-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: in_1234568

The ID of the invoice

Responses

Response samples

Content type
application/json
{}

users-api

The user management API to manage user metadata

ChangeUserRole users-api

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

Responses

Request samples

Content type
application/json
{
  • "email": "abc@gmail.com",
  • "newRoleType": "root|editor|reader|service_editor|service_reader|admin|service_operator"
}

CustomerDeleteUser users-api

Authorizations:
api_key_header_Authorization

Responses

CustomerInviteUser 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
{
  • "email": "abc@example.com"
}

CustomerLoginWithIdentityProvider users-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
object

Additional attributes for the user

authorizationCode
required
string

The authorization code from the Identity Provider

companyDescription
string non-empty
companyUrl
string non-empty
environmentType
string

The environment type of the portal that the customer is signing in to

identityProviderName
string

The name or type of the Identity Provider

invitedEmail
string <email>

Email address that the user was invited with

legalCompanyName
string non-empty
redirectUri
string

The redirect URI used to get the authorization code

state
string

The state parameter used to prevent CSRF attacks

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "authorizationCode": "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&",
  • "companyDescription": "We sell xyz database software",
  • "companyUrl": "https://www.mywebsite.com",
  • "environmentType": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "identityProviderName": "Google|GitHub|Microsoft Entra|Amazon Cognito|Okta|Auth0|Keycloak|OIDC",
  • "invitedEmail": "abc@gmail.com",
  • "legalCompanyName": "mywebsite",
  • "redirectUri": "https://www.example/redirect",
  • "state": "state"
}

Response samples

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

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
{
  • "email": "abc@example.com"
}

CustomerSignin users-api

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

The environment type of the portal that the customer is signing in to

hashedPassword
string non-empty
password
string non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "abc@gmail.com",
  • "environmentType": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "hashedPassword": "deprecated",
  • "password": "password"
}

Response samples

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

CustomerSignup users-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
object

Additional attributes for the user signup

companyDescription
string non-empty
companyUrl
string non-empty
email
required
string <email> non-empty

Email address of the end-user

legalCompanyName
string
Default: ""
name
required
string non-empty

Name of the end-user

password
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "companyDescription": "We sell xyz database software",
  • "companyUrl": "https://www.mywebsite.com",
  • "email": "abc@gmail.com",
  • "legalCompanyName": "mywebsite",
  • "name": "John Doe",
  • "password": "password"
}

InviteUser users-api

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

Responses

Request samples

Content type
application/json
{
  • "email": "abc@gmail.com",
  • "roleType": "root|editor|reader|service_editor|service_reader|admin|service_operator"
}

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

Responses

Request samples

Content type
application/json
{
  • "email": "abc@gmail.com",
  • "roleType": "root|editor|reader|service_editor|service_reader|admin|service_operator"
}

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": {
    },
  • "attributes": {
    },
  • "createdAt": "2023-01-10T00:00:00Z",
  • "email": "abc@gmail.com",
  • "enabled": true,
  • "featureFlags": {
    },
  • "id": "user-abcd1234",
  • "lastModifiedAt": "2023-01-20T00:00:00Z",
  • "name": "John Dae",
  • "orgCookiePolicy": "Sed et nihil porro rem.",
  • "orgDescription": "ACME Inc.",
  • "orgDisablePasswordLogin": false,
  • "orgFavIconURL": "Vel quaerat quis.",
  • "orgId": "org-aKQ8G13QeR",
  • "orgLogoURL": "Quaerat rerum porro molestias qui.",
  • "orgName": "ACME",
  • "orgPrivacyPolicy": "Nam ut.",
  • "orgSupportEmail": "support@example.com",
  • "orgTermsOfUse": "Dolores ad et quis mollitia aspernatur.",
  • "orgURL": "something.acme",
  • "planName": "STARTER_NO_COMMIT|STARTER|GROWTH|ENTERPRISE",
  • "roleType": "root|editor|reader|service_editor|service_reader|admin|service_operator",
  • "status": "ACTIVE|NOT_ENABLED"
}

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)
object

Additional attributes of the user.

name
string

The name of the user

orgCookiePolicy
string

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

orgDescription
string

The description of the org that this user owns

orgDisablePasswordLogin
boolean

Whether password login is disabled for 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": {
    },
  • "attributes": {
    },
  • "name": "John Dae",
  • "orgCookiePolicy": "Fugit distinctio voluptatem autem aliquid.",
  • "orgDescription": "ACME Inc.",
  • "orgDisablePasswordLogin": true,
  • "orgFavIconURL": "http://yosthamill.name/eddie_dare",
  • "orgLogoURL": "http://jacobsonstracke.biz/michael",
  • "orgName": "ACME",
  • "orgPrivacyPolicy": "Id rerum cum et.",
  • "orgSupportEmail": "support@example.com",
  • "orgTermsOfUse": "Iusto quo consequatur unde repellat.",
  • "orgURL": "something.acme"
}

consumption-user-api

The Consumption Signin API signs the user into the consumption service

ListAllSubscriptionUsers consumption-user-api

Authorizations:
api_key_header_Authorization
query Parameters
environmentType
string
Example: environmentType=DEV

The environment type to filter by

Responses

Response samples

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

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

Responses

Request samples

Content type
application/json
{
  • "email": "abc@gmail.com",
  • "roleType": "root|editor|reader|service_editor|service_reader|admin|service_operator"
}

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

Responses

Request samples

Content type
application/json
{
  • "email": "abc@gmail.com",
  • "roleType": "root|editor|reader|service_editor|service_reader|admin|service_operator"
}

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
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": "5"
}

services-orchestration-api

The Services Orchestration API manages the orchestration of services

ListServicesOrchestrations services-orchestration-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

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

CreateServicesOrchestration services-orchestration-api

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

base64 encoded content of service orchestration create DSL

Responses

Request samples

Content type
application/json
{
  • "orchestrationCreateDSL": "Incidunt iste."
}

Response samples

Content type
application/json
{
  • "id": "Sed quasi ut praesentium aut aut nobis."
}

DeleteServicesOrchestration services-orchestration-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: so-12345678

The ID of the services orchestration

Responses

DescribeServicesOrchestration services-orchestration-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: so-12345678

The ID of the services orchestration

Responses

Response samples

Content type
application/json
{
  • "ServicesTopology": [
    ],
  • "createdAt": "2021-01-01T00:00:00Z",
  • "id": "Sit quasi eius minima sit ut aut.",
  • "orchestrationFailedReason": "Invalid DSL",
  • "resultParams": {
    },
  • "status": "PENDING",
  • "updatedAt": "2021-01-01T00:00:00Z"
}

ModifyServicesOrchestration services-orchestration-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: so-12345678

The ID of the services orchestration

Request Body schema: application/json
required
orchestrationModifyDSL
required
string

base64 encoded content of services orchestration modify DSL

Responses

Request samples

Content type
application/json
{
  • "orchestrationModifyDSL": "Molestiae placeat velit similique animi."
}

resource-instance-api

The Resource Instance API manages the instances of a resource

ListAllResourceInstances resource-instance-api

Authorizations:
api_key_header_Authorization
query Parameters
environmentType
string
Example: environmentType=DEV

The environment type to filter by

Responses

Response samples

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

GenerateTokenForDeploymentCellDashboard resource-instance-api

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

The instance ID whose deployment cell dashboard token is to be generated

query Parameters
subscriptionId
required
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "deploymentCellID": "hc-12345678",
  • "expirationTimestamp": "2021-01-01T00:00:00Z",
  • "token": "token"
}

UpgradeResourceInstanceVersion resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
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
productTierKey
required
string

The product tier name

resourceKey
required
string

The resource key

serviceAPIVersion
required
string

The service API version

serviceEnvironmentKey
required
string

The service environment name

serviceKey
required
string

The service name

serviceModelKey
required
string

The service model name

serviceProviderId
required
string

The service provider ID

targetVersion
string

The version to upgrade to

Responses

Request samples

Content type
application/json
{
  • "productTierKey": "premium",
  • "resourceKey": "mysql",
  • "serviceAPIVersion": "v1",
  • "serviceEnvironmentKey": "dev",
  • "serviceKey": "service-orchestration",
  • "serviceModelKey": "hosted",
  • "serviceProviderId": "Sapiente vel.",
  • "targetVersion": "2.0"
}

ListResourceInstances resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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
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

header Parameters
Idempotency-Key
string [ 1 .. 255 ] characters
Example: 6a7b1c2d-3e4f-5061-7283-94a5b6c7d8e9

Makes this create safe to retry. Sending the same key with the same request returns the instance the first call created instead of creating a second one; sending it with a different request is rejected with 409. Keys are scoped to the calling user and expire 24 hours after first use

Request Body schema: application/json
required
cloud_provider
string

The cloud provider name

custom_network_id
string

Custom network for resource

Array of objects (CustomTag)

The custom tags for the resource instance

externalBillingId
string

This externalBillingId is deprecated and will be removed in the future

network_type
string

The network type

onprem_platform
string

OnPrem platform

productTierVersion
string

The product tier version

region
string

The region code

requestParams
any

The request parameters

Responses

Request samples

Content type
application/json
{
  • "cloud_provider": "aws",
  • "custom_network_id": "n-1234567890",
  • "customTags": [
    ],
  • "externalBillingId": "external-billing-id-1234",
  • "network_type": "PUBLIC|INTERNAL",
  • "onprem_platform": "OpenShift",
  • "productTierVersion": "1.0",
  • "region": "us-east-1",
  • "requestParams": {
    }
}

Response samples

Content type
application/json
{
  • "id": "Quis et voluptatibus rerum facilis ut."
}

DeleteResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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

skipFinalSnapshot
boolean
Default: false
Example: skipFinalSnapshot=true

Skip taking final snapshot before deletion. If false (default), a final snapshot will be taken before deletion if snapshot-before-deletion is enabled on the plan.

Responses

DescribeResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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,
  • "autoscalingEnabled": true,
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "backupStatus": {
    },
  • "cloud_provider": "aws",
  • "created_at": "2023-01-10T00:00:00Z",
  • "createdByUserId": "Sint impedit quisquam est.",
  • "createdByUserName": "John Doe",
  • "currentReplicas": "2",
  • "customNetworkDetail": {
    },
  • "customTags": [
    ],
  • "detailedNetworkTopology": {
    },
  • "externalPayerId": "external-payer-id-1234",
  • "gcpProjectID": "my-project",
  • "highAvailability": true,
  • "id": "instance-abcd1234",
  • "instanceLoadStatus": "LOAD_NORMAL|LOAD_IDLE|LOAD_OVERLOADED|STOPPED|UNKNOWN|N/A",
  • "kubernetesDashboardEndpoint": {},
  • "last_modified_at": "2023-01-20T00:00:00Z",
  • "launch_input_params": {
    },
  • "maintenanceTasks": {
    },
  • "maxReplicas": "1",
  • "minReplicas": "1",
  • "nebiusTenantID": "tenant-e00ezh17k22wmwq5f0",
  • "network_type": "PUBLIC|INTERNAL",
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "onPremInstallerDetails": {},
  • "onpremPlatform": "EKS|GKE|AKS|Generic",
  • "productTierFeatures": {
    },
  • "productTierVersionDetail": {
    },
  • "region": "us-east-1",
  • "resourceID": "Est dolorum.",
  • "resourceInstanceMetadata": {
    },
  • "result_params": {
    },
  • "serverlessEnabled": true,
  • "snapshotBeforeDeletionEnabled": true,
  • "sourceSnapshotID": "instance-ss-abcd1234",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "subscriptionId": "sub-abcd1234",
  • "subscriptionLicense": {
    },
  • "subscriptionStatus": "ACTIVE|SUSPENDED|TERMINATED|CANCELLED",
  • "supportedOperations": [
    ],
  • "tierVersion": "1.0"
}

UpdateResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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
Array of objects (CustomTag)

The custom tag for the resource instance

network_type
string

The network type

requestParams
any

The request parameters

Responses

Request samples

Content type
application/json
{
  • "customTags": [
    ],
  • "network_type": "PUBLIC|INTERNAL",
  • "requestParams": {
    }
}

AddCapacityToResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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
}

CopyResourceInstanceSnapshot resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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
sourceSnapshotId
string

The source snapshot ID

targetRegion
required
string

The target region to copy the snapshot to

Responses

Request samples

Content type
application/json
{
  • "sourceSnapshotId": "Pariatur rerum minus necessitatibus consequatur quod ipsa.",
  • "targetRegion": "us-west-2"
}

Response samples

Content type
application/json
{
  • "snapshotId": "Voluptas aut exercitationem."
}

RemoveCustomDNSFromResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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: http-service

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Responses

AddCustomDNSToResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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: http-service

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
customDNS
required
string

The custom DNS to add

targetPort
integer <int64>

The target port

Responses

Request samples

Content type
application/json
{
  • "customDNS": "my-custom-dns.com",
  • "targetPort": 8080
}

ResourceInstanceCustomWorkflow resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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: postgres

The resource key

id
required
string
Example: instance-abcd1234

The instance ID

workflowId
required
string
Example: cwt-12345678

The custom workflow ID from the instance's supportedOperations list.

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Request Body schema: application/json
required
requestParams
any

Input parameters for the custom workflow. System workflow operations do not require user supplied parameters.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "workflowExecutionId": "Aut ut iste doloribus eos.",
  • "workflowId": "Eius expedita delectus odio."
}

FailoverResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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

The failed replica action

failedReplicaID
required
string

The failed replica ID

Responses

Request samples

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

UpdateResourceInstanceMetadata resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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
Array of objects (CustomTag)

The custom tag for the resource instance

deletionProtection
boolean

Set to true to enable deletion protection or false to disable it

Responses

Request samples

Content type
application/json
{
  • "customTags": [
    ],
  • "deletionProtection": true
}

RemoveCapacityFromResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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
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

RestoreResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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
network_type
string

The network type

targetRestoreTime
required
string

The target restore time

Responses

Request samples

Content type
application/json
{
  • "network_type": "PUBLIC|INTERNAL",
  • "targetRestoreTime": "2021-09-01T00:00:00Z"
}

Response samples

Content type
application/json
{
  • "id": "Quibusdam laborum aut."
}

ListResourceInstanceSnapshots resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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

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
{
  • "snapshots": [
    ]
}

StartResourceInstance resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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
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

RestoreResourceInstanceFromSnapshot resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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

snapshotId
required
string
Example: instance-ss-abcd1234

The snapshot ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

Subscription Id

Request Body schema: application/json
required
custom_network_id
string

Custom network for resource

network_type
string

The network type

Responses

Request samples

Content type
application/json
{
  • "custom_network_id": "n-1234567890",
  • "network_type": "PUBLIC|INTERNAL"
}

Response samples

Content type
application/json
{
  • "id": "Omnis et."
}

ResourceInstanceProvisionerSetupKit resource-instance-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
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

UpdateAccountConfigResourceInstance resource-instance-api

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

The instance ID

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

Full replacement set of custom tags for the backing account configuration

Array of objects (UpdateAccountConfigNebiusBindingInput)

Full replacement set of Nebius bindings for this account config instance

serviceId
required
string

The service ID

setConnection
boolean

set account config instance connection

subscriptionId
required
string

The subscription ID

Responses

Request samples

Content type
application/json
{
  • "customTags": [
    ],
  • "nebiusBindings": [
    ],
  • "serviceId": "service-1234",
  • "setConnection": true,
  • "subscriptionId": "sub-abcd1234"
}

instance-snapshot-api

The Instance Snapshot API manages the snapshots of resource instances

ListAllInstanceSnapshots instance-snapshot-api

Authorizations:
api_key_header_Authorization
query Parameters
environmentType
string
Example: environmentType=DEV

The environment type to filter by

snapshotType
string
Example: snapshotType=AutomatedSnapshot|ManualSnapshot

The type of snapshot to list. Valid values are: 'ManualSnapshot' and 'AutomatedSnapshot'

Responses

Response samples

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

CreateInstanceSnapshot instance-snapshot-api

Authorizations:
api_key_header_Authorization
query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

The subscription ID

Request Body schema: application/json
required
instanceId
required
string

The instance ID

targetRegion
string

The target region to create the snapshot in. If not specified, use the same region as the instance

Responses

Request samples

Content type
application/json
{
  • "instanceId": "instance-abcd1234",
  • "targetRegion": "us-west-2"
}

Response samples

Content type
application/json
{
  • "id": "Voluptates aspernatur quis in fugiat tempore."
}

DeleteInstanceSnapshot instance-snapshot-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: instance-ss-12345678

The instance snapshot ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

The subscription ID

Responses

DescribeInstanceSnapshot instance-snapshot-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: instance-ss-12345678

The instance snapshot ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

The subscription ID

Responses

Response samples

Content type
application/json
{
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "completeTime": "2021-09-01T00:00:00Z",
  • "createdTime": "2021-09-01T00:00:00Z",
  • "encrypted": true,
  • "outputParams": [
    ],
  • "productTierId": "Recusandae accusantium.",
  • "productTierName": "Premium",
  • "productTierVersion": "1.0",
  • "productTierVersionDescription": "Version 1.0",
  • "progress": 99,
  • "region": "us-west-2",
  • "serviceId": "s-123456",
  • "serviceName": "Postgres",
  • "snapshotId": "Laboriosam dolores voluptate est.",
  • "snapshotMetadata": {
    },
  • "snapshotType": "AutomatedSnapshot|ManualSnapshot",
  • "sourceInstanceId": "instance-12345678",
  • "status": "completed",
  • "subscriptionId": "Facere et incidunt et voluptatum.",
  • "subscriptionOwnerOrgId": "Suscipit laboriosam laboriosam ad culpa aut.",
  • "subscriptionOwnerOrgName": "Example Inc.",
  • "subscriptionOwnerUserId": "Consequatur qui.",
  • "subscriptionOwnerUserName": "Admin"
}

RestoreResourceInstanceFromSnapshot instance-snapshot-api

Authorizations:
api_key_header_Authorization
path Parameters
snapshotId
required
string
Example: instance-ss-abcd1234

The snapshot ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

The subscription ID

Request Body schema: application/json
required
custom_network_id
string

Custom network for resource

network_type
string

The network type

Responses

Request samples

Content type
application/json
{
  • "custom_network_id": "n-1234567890",
  • "network_type": "PUBLIC|INTERNAL"
}

Response samples

Content type
application/json
{
  • "instanceId": "Et et harum possimus."
}

CopyInstanceSnapshot instance-snapshot-api

Authorizations:
api_key_header_Authorization
path Parameters
sourceSnapshotId
required
string
Example: instance-ss-abcd1234

The source snapshot ID

query Parameters
subscriptionId
string
Example: subscriptionId=sub-abcd1234

The subscription ID

Request Body schema: application/json
required
targetRegion
required
string

The target region to copy the snapshot to

Responses

Request samples

Content type
application/json
{
  • "targetRegion": "us-west-2"
}

Response samples

Content type
application/json
{
  • "id": "Dicta fugit quisquam ipsam inventore qui et."
}

consumption-usage-api

The Consumption Usage API retrieves the usage data for consumption users

GetCurrentConsumptionUsage consumption-usage-api

Authorizations:
api_key_header_Authorization
query Parameters
subscriptionID
string
Example: subscriptionID=sub-12345678

The subscription ID to get usage for

Responses

Response samples

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

GetConsumptionUsagePerDay consumption-usage-api

Authorizations:
api_key_header_Authorization
query Parameters
startDate
string <date-time>
Example: startDate=2023-01-01T10:00:00Z

Start date of the usage report

endDate
string <date-time>
Example: endDate=2024-01-01T10:00:00Z

End date of the usage report

subscriptionID
string
Example: subscriptionID=sub-12345678

The subscription ID to get usage for

Responses

Response samples

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

consumption-invoice-api

The Consumption Invoice API retrieves the invoice data for consumption users

ListConsumptionInvoices consumption-invoice-api

Authorizations:
api_key_header_Authorization
query Parameters
billingProvider
string
Example: billingProvider=STRIPE

Billing provider. If specified, list invoices for the specified billing provider.

Responses

Response samples

Content type
application/json
{}

consumption-billing-api

The Consumption Invoice API retrieves the billing information for consumption users

DescribeConsumptionBillingDetails consumption-billing-api

Authorizations:
api_key_header_Authorization
query Parameters
returnUrl
string
Example: returnUrl=https://mysaasportal.com

Return Url used to configure payment methods links

supportsCustomPaymentPortal
boolean
Example: supportsCustomPaymentPortal=true

Whether the caller supports inline custom payment method management

Responses

Response samples

Content type
application/json
{}

DescribeConsumptionBillingStatus consumption-billing-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

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

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

azureSubscriptionID
string

The Azure subscription ID

azureTenantID
string

The Azure tenant ID

byoaInstanceID
string

The BYOA instance ID that this account config is tied to

cloudProviderId
required
string

Cloud Provider ID to operate on

Array of objects (CustomTag)

The custom tags for the account configuration

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

Array of objects (NebiusAccountBindingInput)

The Nebius per-region project/service-account bindings for the tenant-scoped Nebius account configuration

nebiusTenantID
string

The Nebius tenant ID for the tenant-scoped Nebius account configuration

ociDomainID
string

The Domain OCID for Oracle Cloud Infrastructure

ociTenancyID
string

The Tenancy OCID for Oracle Cloud Infrastructure

Responses

Request samples

Content type
application/json
{
  • "awsAccessKey": "Nemo magni eos perferendis.",
  • "awsAccountID": "123456789012",
  • "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
  • "awsSecretKey": "Dolorem similique natus et a ipsa est.",
  • "azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
  • "azureTenantID": "12345678-1234-1234-1234-123456789012",
  • "byoaInstanceID": "instance-12345678",
  • "cloudProviderId": "Non vel voluptatem vel dolorum ut.",
  • "customTags": [
    ],
  • "description": "An AWS account hosting multiple dev environments",
  • "gcpProjectID": "my-project",
  • "gcpProjectNumber": "123456789012",
  • "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
  • "gcpServiceAccountKey": "Consectetur doloremque accusantium voluptas odio.",
  • "name": "Dev AWS account",
  • "nebiusBindings": [
    ],
  • "nebiusTenantID": "tenant-id",
  • "ociDomainID": "ocid1.domain.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Response samples

Content type
application/json
"Deleniti ad sint."

DeleteAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: ac-12345678

Account Config ID to operate on

Responses

DescribeAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
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>",
  • "awsCloudFormationNoLBTemplateURL": "https://s3.amazonaws.com/omnistrate-cloudformation/org-EUVvex3bVm/account-config-setup-template-no-lb-policy.yaml",
  • "awsCloudFormationTemplateURL": "https://s3.amazonaws.com/omnistrate-cloudformation/org-EUVvex3bVm/account-config-setup-template.yaml",
  • "azureBootstrapShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/azure-bootstrap.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "azureDisconnectShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/azure-disconnect.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "azureOffboardShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/azure-offboard.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
  • "azureTenantID": "12345678-1234-1234-1234-123456789012",
  • "byoaInstanceIDs": [
    ],
  • "cloudProviderId": "Sapiente quidem neque id architecto a.",
  • "customTags": [
    ],
  • "description": "An AWS account hosting multiple dev environments",
  • "gcpBootstrapShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/gcp-bootstrap.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "gcpDisconnectShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/gcp-disconnect.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "gcpOffboardShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/gcp-offboard.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "gcpProjectID": "my-project",
  • "gcpProjectNumber": "123456789012",
  • "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
  • "id": "Unde vel.",
  • "name": "Dev AWS account",
  • "nebiusBindings": [
    ],
  • "nebiusTenantID": "tenant-e00abc123",
  • "ociBootstrapShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/oci-bootstrap.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "ociDisconnectShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/oci-disconnect.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "ociDomainID": "ocid1.domain.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "ociOffboardShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/oci-offboard.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "status": "PENDING|VERIFYING|READY|FAILED|DELETING|READY_TO_OFFBOARD",
  • "statusMessage": "Account is ready"
}

UpdateAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: ac-12345678

Account Config ID to operate on

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

Full replacement set of custom tags for the account configuration

description
string

The updated description for the account

name
string

The updated name of the account

Array of objects (NebiusAccountBindingInput)

Full replacement set of Nebius project/service-account bindings for an existing tenant-scoped Nebius account configuration

Responses

Request samples

Content type
application/json
{
  • "customTags": [
    ],
  • "description": "Nebius account for eu-north1 and eu-west1 projects",
  • "name": "Updated Nebius account",
  • "nebiusBindings": [
    ]
}

Response samples

Content type
application/json
"Natus aut occaecati."

ListAccountConfigCloudNativeNetworks account-config-api

List all registered CloudNativeNetworks for an account configuration

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: ac-12345678

Account Config ID to operate on

Responses

Response samples

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

ImportAccountConfigCloudNativeNetworkHostCluster account-config-api

Import a discovered host cluster from an imported cloud native network

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: ac-12345678

Account Config ID to operate on

region
required
string
Example: us-east-1

The deployment region where the host cluster resides

cloudNativeNetworkId
required
string
Example: vpc-0abc123def456

The cloud provider network ID (e.g. AWS VPC ID) that contains the host cluster to import

hostClusterName
required
string
Example: existing-eks-cluster

The cloud provider host cluster name to import from this cloud native network

Responses

Response samples

Content type
application/json
{
  • "created": true,
  • "hostClusterId": "Tempore modi."
}

ImportAccountConfigCloudNativeNetwork account-config-api

Import an available cloud native network for deployments (sets status to READY)

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: ac-12345678

Account Config ID to operate on

region
required
string
Example: us-east-1

The deployment region whose validated subnetworks should be imported

cloudNativeNetworkId
required
string
Example: /subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/customer-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet

The provider-native network ID (for example, AWS VPC ID, GCP VPC name, or Azure VNet resource ID) to import for deployments

Responses

Response samples

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

UnimportAccountConfigCloudNativeNetwork account-config-api

Unimport a cloud native network, reverting it from READY to AVAILABLE

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: ac-12345678

Account Config ID to operate on

region
required
string
Example: us-east-1

The deployment region whose cloud native network row should be unimported

cloudNativeNetworkId
required
string
Example: /subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/customer-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet

The provider-native network ID (for example, AWS VPC ID, GCP VPC name, or Azure VNet resource ID) to unimport. Rejected with HTTP 400 if the network is currently in use by a host cluster.

Responses

Response samples

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

BulkImportAccountConfigCloudNativeNetworks account-config-api

Bulk import or unimport CloudNativeNetworks for deployments

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: ac-12345678

Account Config ID to operate on

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

List of cloud native network operations to perform

Responses

Request samples

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

Response samples

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

SyncAccountConfigCloudNativeNetworks account-config-api

Sync CloudNativeNetworks from the provider's cloud account: discovers CloudNativeNetworks and upserts them into the database

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: ac-12345678

Account Config ID to operate on

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

Optional list of (region, cloudNativeNetworkId) targets to sync. Each target is {region (required), cloudNativeNetworkId (optional)}: with the network ID set, only that network is re-validated; with the network ID omitted, every supported network in the region is enumerated. If the entire list is empty, the sync sweeps every region the account is enabled in (derived from the service plan).

Responses

Request samples

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

Response samples

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

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
{}

DescribeAccountConfigByAzureSubscriptionID account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
azureSubscriptionID
required
string
Example: 12345678-1234-1234-1234-123456789012

The Azure subscription ID

Responses

Response samples

Content type
application/json
{
  • "azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
  • "azureTenantID": "12345678-1234-1234-1234-123456789012",
  • "byoaInstanceIDs": [
    ],
  • "cloudProviderId": "Veritatis perspiciatis harum deserunt aut iure.",
  • "description": "An AWS account hosting multiple dev environments",
  • "id": "Et sed.",
  • "name": "Dev AWS account",
  • "status": "PENDING|VERIFYING|READY|FAILED|DELETING|READY_TO_OFFBOARD",
  • "statusMessage": "Account is ready"
}

ListBYOAConfig account-config-api

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

Cloud Provider name to filter on

Responses

Request samples

Content type
application/json
{
  • "cloudProviderName": "aws|azure|gcp|nebius|oci|byoc-onprem|all"
}

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
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": "Repudiandae eos omnis laudantium nemo ut alias.",
  • "description": "An AWS account hosting multiple dev environments",
  • "gcpProjectID": "my-project",
  • "gcpProjectNumber": "123456789012",
  • "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
  • "id": "Labore facere.",
  • "name": "Dev AWS account",
  • "status": "PENDING|VERIFYING|READY|FAILED|DELETING|READY_TO_OFFBOARD",
  • "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": "Et aut."
}

DescribeAccountConfigByNebiusTenantID account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
nebiusTenantID
required
string
Example: tenant-id

The Nebius tenant ID

Responses

Response samples

Content type
application/json
{
  • "byoaInstanceIDs": [
    ],
  • "cloudProviderId": "Est dolorem.",
  • "description": "A Nebius tenant account hosting multiple regional project bindings",
  • "id": "Culpa praesentium atque cum.",
  • "name": "Prod Nebius tenant account",
  • "nebiusBindings": [
    ],
  • "nebiusTenantID": "tenant-e00abc123",
  • "status": "PENDING|VERIFYING|READY|FAILED|DELETING|READY_TO_OFFBOARD",
  • "statusMessage": "Account is ready"
}

DescribeAccountConfigByOCITenancyID account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
ociTenancyID
required
string
Example: ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

The Tenancy OCID for Oracle Cloud Infrastructure

Responses

Response samples

Content type
application/json
{
  • "byoaInstanceIDs": [
    ],
  • "cloudProviderId": "Nisi corporis ad.",
  • "description": "An OCI account hosting multiple dev environments",
  • "id": "Porro amet tempore sed eos voluptate nobis.",
  • "name": "Dev OCI account",
  • "ociDomainID": "ocid1.domain.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "status": "PENDING|VERIFYING|READY|FAILED|DELETING|READY_TO_OFFBOARD",
  • "statusMessage": "Account is ready"
}

VerifyAccountConfig account-config-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
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": [