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

Download OpenAPI specification:Download

REST API for Omnistrate Service Registration

global-api

Common API for all Omnistrate API endpoints

registrationServiceHealth global-api

Registration service health check endpoint

Responses

Response samples

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

consumptionServiceHealth global-api

Consumption service health check endpoint

Responses

Response samples

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

consumptionServiceVersion global-api

Consumption service version endpoint

Responses

Response samples

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

registrationServiceVersion global-api

Registration service version endpoint

Responses

Response samples

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

service-api

ListService service-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

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

CreateService service-api

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

A brief description of the service

name
required
string

Name of the Service

serviceLogoURL
string <uri>

The logo for the service

Responses

Request samples

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

Response samples

Content type
application/json
"s-12345678"

DeleteService service-api

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

The service ID to operate on

Responses

DescribeService service-api

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

The service ID to operate on

Responses

Response samples

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

UpdateService service-api

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

The service ID to operate on

Request Body schema: application/json
required
description
string

A brief description of the service

name
string

Name of the Service

serviceLogoURL
string <uri>

The logo for the service

Responses

Request samples

Content type
application/json
{}

ServiceHealth service-api

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

The ID of the service

Responses

Response samples

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

CreateServiceFromComposeSpec service-api

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

A brief description of the service

fileContent
required
string

Base64 encoded Compose Spec YAML in docker compose format

fileFormat
required
string

MIME type of file format

fileName
required
string

Name of compose spec YAML file that is uploaded

name
required
string

Name of the Service

serviceLogoURL
string <uri>

The logo for the service

Responses

Request samples

Content type
application/json
{
  • "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
  • "fileContent": "Occaecati earum voluptate.",
  • "fileFormat": "text/plain",
  • "fileName": "mysql.yaml",
  • "name": "MySQL multi-writer service",
  • "serviceLogoURL": "http://rath.info/araceli"
}

Response samples

Content type
application/json
"s-12345678"

BuildServiceFromComposeSpec service-api

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

A brief description of the service

fileContent
required
string

Base64 encoded Compose Spec YAML in docker compose format

name
required
string

Name of the Service

release
boolean

Release the service after building

releaseAsPreferred
boolean

Release the service as preferred

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": "Qui inventore deleniti labore.",
  • "name": "MySQL multi-writer service",
  • "release": true,
  • "releaseAsPreferred": true,
  • "serviceLogoURL": "http://hahn.name/colin.ernser"
}

Response samples

Content type
application/json
{
  • "productTierID": "pt-12345678",
  • "serviceEnvironmentID": "se-12345678",
  • "serviceID": "s-12345678"
}

service-environment-api

ListServiceEnvironment service-environment-api

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

The ID of the service this environment belongs to

Responses

Response samples

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

CreateServiceEnvironment service-environment-api

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

The ID of the service this environment belongs to

Request Body schema: application/json
required
autoApproveSubscription
boolean

Auto approve subscription or not

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

The deployment configuration ID

description
required
string

A brief description of the service environment

name
required
string

Name of the Service Environment

serviceAuthPublicKey
string

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

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

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

visibility
string
Enum: "PUBLIC" "PRIVATE"

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

Responses

Request samples

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

Response samples

Content type
application/json
"se-12345678"

DeleteServiceEnvironment service-environment-api

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

The ID of the service this environment belongs to

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

The ID of the service environment

Responses

DescribeServiceEnvironment service-environment-api

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

The ID of the service this environment belongs to

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

The ID of the service environment

Responses

Response samples

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

UpdateServiceEnvironment service-environment-api

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

The ID of the service this environment belongs to

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

The ID of the service environment

Request Body schema: application/json
required
autoApproveSubscription
boolean

Auto approve subscription or not

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

The deployment configuration ID

description
string

A brief description of the service environment

name
string

Name of the Service Environment

serviceAuthPublicKey
string

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

sourceEnvironmentId
string

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

visibility
string
Enum: "PUBLIC" "PRIVATE"

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

Responses

Request samples

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

PromoteServiceEnvironmentStatus service-environment-api

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

The ID of the service this environment belongs to

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

The ID of the service environment

Responses

Response samples

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

PromoteServiceEnvironment service-environment-api

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

The ID of the service this environment belongs to

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

The ID of the service environment

Responses

service-model-api

CreateServiceModel service-model-api

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

The service this model is for

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

The infrastructure account configuration ID list

description
required
string

A brief description of the service model

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

The model type encapsulating this service

name
required
string

Name of the Service Model

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

The service API this model is for

Responses

Request samples

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

Response samples

Content type
application/json
"sm-12345678"

DeleteServiceModel service-model-api

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

The service ID this model belongs to

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

The service model ID

Responses

DescribeServiceModel service-model-api

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

The service ID this model belongs to

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

The service model ID

Responses

Response samples

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

UpdateServiceModel service-model-api

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

The service ID this model belongs to

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

The service model ID

Request Body schema: application/json
required
description
string

A brief description of the service model

name
string

Name of the Service Model

Responses

Request samples

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

RemoveAccountConfigFromServiceModel service-model-api

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

The service ID this model belongs to

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

The service model ID

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

The infrastructure account configuration ID

Responses

Request samples

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

AddAccountConfigToServiceModel service-model-api

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

The service ID this model belongs to

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

The service model ID

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

The infrastructure account configuration ID

Responses

Request samples

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

SetActiveAccountConfig service-model-api

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

The service ID this model belongs to

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

The service model ID

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

The infrastructure account configuration ID

Responses

ReleaseServiceModelStatus service-model-api

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

The service ID this model belongs to

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

The service model ID

Responses

Response samples

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

CopyServiceModel service-model-api

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

The service ID this model belongs to

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

The source service model ID

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

The infrastructure account configuration ID list

description
required
string

A brief description of the service model

name
required
string

Name of the Service Model

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

The model type encapsulating this service

targetTierType
string
Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY"

Target product tier type

Responses

Request samples

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

Response samples

Content type
application/json
"sm-12345678"

ListServiceModel service-model-api

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

The service ID

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

The service API ID

Responses

Response samples

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

product-tier-api

ListProductTier product-tier-api

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

Service ID

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

Service model ID

Responses

Response samples

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

CreateProductTier product-tier-api

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

Service ID

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

The AWS regions that this product tier is available on

description
required
string

A brief description of the product tier

documentation
string

Documentation

gcpRegions
Array of strings

The GCP regions that this product tier is available on

isDisabled
boolean

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

name
required
string

Name of the product tier

planDescription
required
string

A brief description for the end user of the product tier

pricing
string <binary>

Pricing

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

Service model ID

support
string

Support

tierType
required
string
Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY"

Tier type

Responses

Request samples

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

Response samples

Content type
application/json
"pt-12345678"

DeleteProductTier product-tier-api

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

Service ID

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

Product tier ID

Responses

DescribeProductTier product-tier-api

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

Service ID

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

Product tier ID

Responses

Response samples

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

UpdateProductTier product-tier-api

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

Service ID

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

Product tier ID

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

The AWS regions that this product tier is available on

description
string

A brief description of the product tier

documentation
string

Documentation

gcpRegions
Array of strings

The GCP regions that this product tier is available on

isDisabled
boolean

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

name
string

Name of the product tier

planDescription
string

A brief description for the end user of the product tier

pricing
string <binary>

Pricing

support
string

Support

tierType
string
Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY"

Tier type

Responses

Request samples

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

ListProductTierBillingPlan product-tier-api

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

Service ID

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

Product tier ID

Responses

Response samples

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

CreateProductTierBillingPlan product-tier-api

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

Service ID

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

Product tier ID

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
required
boolean

Allow creates when payment not configured

maxNumberofInstances
required
integer <int64>

Maximum number of instances

planName
required
string

Plan name

pricing
required
string <binary>

Pricing in dollars.

Responses

Request samples

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

Response samples

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

DisableProductTierFeature product-tier-api

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

Service ID

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

Product tier ID

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

Feature to disable

scope
string
Enum: "INTERNAL" "CUSTOMER"

Feature scope

Responses

Request samples

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

EnableProductTierFeature product-tier-api

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

Service ID

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

Product tier ID

Request Body schema: application/json
required
object

The configuration parameters of the product tier feature

feature
required
string
Enum: "LOGS" "METRICS" "BILLING" "ALERTS" "CLOUD_INSURANCE" "MARKETPLACE" "OPERATIONS_AUTOMATION" "OPERATIONAL_STATUS"

Feature to enable

scope
string
Enum: "INTERNAL" "CUSTOMER"

Feature scope

Responses

Request samples

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

DeleteProductTierBillingPlan product-tier-api

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

Service ID

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

Product tier ID

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

Product tier billing plan ID

Responses

DescribeProductTierBillingPlan product-tier-api

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

Service ID

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

Product tier ID

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

Product tier billing plan ID

Responses

Response samples

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

UpdateProductTierBillingPlan product-tier-api

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

Service ID

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

Product tier ID

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

Product tier billing plan ID

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
boolean

Allow creates when payment not configured

maxNumberofInstances
integer <int64>

Maximum number of instances

planName
string

Plan name

pricing
string <binary>

Pricing in dollars.

Responses

Request samples

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

Response samples

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

CopyProductTier product-tier-api

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

Service ID

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

The source product tier ID

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

The AWS regions that this product tier is available on

description
required
string

A brief description of the product tier

documentation
string

Documentation

gcpRegions
Array of strings

The GCP regions that this product tier is available on

name
required
string

Name of the product tier

planDescription
string

A brief description for the end user of the product tier

pricing
string <binary>

Pricing

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

Service model ID

support
string

Support

targetTierType
string
Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY"

Tier type

Responses

Request samples

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

Response samples

Content type
application/json
"pt-12345678"

service-api-api

CreateServiceAPI service-api-api

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

The service ID that this API bundle belongs to

Request Body schema: application/json
required
description
required
string

A brief description of the service API bundle

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

The service environment ID

Responses

Request samples

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

Response samples

Content type
application/json
"sa-12345678"

DeleteServiceAPI service-api-api

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

The service ID that this API bundle belongs to

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

The service API ID

Responses

DescribeServiceAPI service-api-api

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

The service ID that this API bundle belongs to

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

The service API ID

Responses

Response samples

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

UpdateServiceAPI service-api-api

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

The service ID that this API bundle belongs to

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

The service API ID

Request Body schema: application/json
required
description
string

A brief description of the service API bundle

Responses

Request samples

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

DiscardPendingChanges service-api-api

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

The service ID that this API bundle belongs to

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

The service API ID

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

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

Responses

DescribePendingChanges service-api-api

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

The service ID that this API bundle belongs to

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

The service API ID

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

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

Responses

Response samples

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

DeprecateServiceAPI service-api-api

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

The service ID that this API bundle belongs to

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

The service API ID

Responses

ReleaseServiceAPI service-api-api

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

The service ID that this API bundle belongs to

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

The service API ID

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

Indicates whether this version set is preferred.

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

The product tier ID

versionSetName
string

The name of the version set to release

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

The version-set type of the product-tier.

Responses

Request samples

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

ListServiceAPI service-api-api

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

The service ID that this API bundle belongs to

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

The service environment ID

Responses

Response samples

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

service-plan-api

ListServicePlans service-plan-api

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

Service ID

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

Service environment ID

Responses

Response samples

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

GetServicePlan service-plan-api

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

Service ID

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

Product tier ID

Responses

Response samples

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

resource-api

ListResources resource-api

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

The ID of the service to list resources for

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

The product tier ID

query Parameters
managed
boolean
Example: managed=false

Is resource managed by omnistrate

ProductTierVersion
string
Example: ProductTierVersion=Reprehenderit sequi quia explicabo.

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

Responses

Response samples

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

CreateResource resource-api

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

The service ID that this API bundle belongs to

Request Body schema: application/json
required
object (BackupConfiguration)
description
required
string

A brief description of the resource

Array of objects (EnvironmentVariable)

The environment variables that this resource requires

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

The ID of the image configuration that this resource refers to

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

The ID of the infrastructure configuration that this resource refers to

internal
boolean
Default: false

Whether this resource is internal or not

isProxy
boolean
Default: false

Whether this resource is a proxy or not

key
string

The key of the resource

object (L4LoadBalancerConfiguration)
object (L7LoadBalancerConfiguration)
name
required
string

Name of the resource

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

The product tier ID

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

A proxy type of resource

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

The type of the resource

Responses

Request samples

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

Response samples

Content type
application/json
"r-12345678"

DeleteResource resource-api

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

The service ID that this API bundle belongs to

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

The ID of the resource

Responses

DescribeResource resource-api

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

The service ID that this API bundle belongs to

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

The ID of the resource

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Nulla unde eaque amet quo quos.

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

ProductTierId
string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][...
Example: ProductTierId=Velit nam harum pariatur ullam quidem fugit.

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

Responses

Response samples

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

UpdateResource resource-api

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

The service ID that this API bundle belongs to

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

The ID of the resource

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

A brief description of the resource

Array of objects (EnvironmentVariable)

The environment variables that this resource requires

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

The ID of the image configuration that this resource refers to

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

The ID of the infrastructure configuration that this resource refers to

object (L4LoadBalancerConfiguration)
object (L7LoadBalancerConfiguration)
name
string

Name of the resource

Responses

Request samples

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

DeregisterActionHook resource-api

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

The ID of the service to which the hook belongs

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

The ID of the resource to which the hook belongs

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

The scope of the hook

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

The type of hook to execute

Responses

Request samples

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

ListActionHooks resource-api

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

The ID of the service to which the hook belongs

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

The ID of the resource to which the hook belongs

Responses

Response samples

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

RegisterActionHook resource-api

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

The ID of the service to which the hook belongs

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

The ID of the resource to which the hook belongs

Request Body schema: application/json
required
commandTemplate
required
string

The Base64 encoded command template to execute

scope
required
string
Enum: "CLUSTER" "NODE"

The scope of the hook

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

The type of hook to execute

Responses

Request samples

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

DisableResourceCapability resource-api

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