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

200

Content type

application/json

{"status": "RUNNING"
}

consumptionServiceHealth global-api

Consumption service health check endpoint

Responses

Response samples

200

Content type

application/json

{"status": "RUNNING"
}

consumptionServiceVersion global-api

Consumption service version endpoint

Responses

Response samples

200

Content type

application/json

{"apiVersion": "el",
"buildCommitSHA": "1234567890abcdef1234567890abcdef12345678",
"buildTimestamp": "2020-01-01T00:00:00Z"
}

registrationServiceVersion global-api

Registration service version endpoint

Responses

Response samples

200

Content type

application/json

{"apiVersion": "lo8",
"buildCommitSHA": "1234567890abcdef1234567890abcdef12345678",
"buildTimestamp": "2020-01-01T00:00:00Z"
}

service-api

ListService service-api

Authorizations:

api_key_header_Authorization

Responses

Response samples

200

Content type

application/json

{"ids": ["s-12345678",
"s-abcdefgh",
"s-1234efgh"
],
"nextPageToken": "next-token",
"services": [{"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": [{"id": "se-12345678",
"name": "dev",
"promoteStatus": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"saasPortalStatus": "READY",
"saasPortalUrl": "https://saas-portal.example.com",
"servicePlans": [{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
},
{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
],
"sourceEnvironmentID": "se-12345678",
"sourceEnvironmentName": "dev",
"type": "DEV",
"visibility": "private"
},
{"id": "se-12345678",
"name": "dev",
"promoteStatus": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"saasPortalStatus": "READY",
"saasPortalUrl": "https://saas-portal.example.com",
"servicePlans": [{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
},
{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
],
"sourceEnvironmentID": "se-12345678",
"sourceEnvironmentName": "dev",
"type": "DEV",
"visibility": "private"
}
],
"serviceLogoURL": "Rerum quis consequatur.",
"serviceProviderID": "sp-12345678",
"serviceProviderName": "Omnistrate, Inc."
},
{"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": [{"id": "se-12345678",
"name": "dev",
"promoteStatus": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"saasPortalStatus": "READY",
"saasPortalUrl": "https://saas-portal.example.com",
"servicePlans": [{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
},
{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
],
"sourceEnvironmentID": "se-12345678",
"sourceEnvironmentName": "dev",
"type": "DEV",
"visibility": "private"
},
{"id": "se-12345678",
"name": "dev",
"promoteStatus": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"saasPortalStatus": "READY",
"saasPortalUrl": "https://saas-portal.example.com",
"servicePlans": [{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
},
{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
],
"sourceEnvironmentID": "se-12345678",
"sourceEnvironmentName": "dev",
"type": "DEV",
"visibility": "private"
}
],
"serviceLogoURL": "Rerum quis consequatur.",
"serviceProviderID": "sp-12345678",
"serviceProviderName": "Omnistrate, Inc."
}
]
}

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

Payload

Content type

application/json

{"description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
"name": "MySQL multi-writer service",
"serviceLogoURL": "http://fahey.biz/retha.dubuque"
}

Response samples

200

Content type

application/json

"s-12345678"

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

200

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": [{"id": "se-12345678",
"name": "dev",
"promoteStatus": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"saasPortalStatus": "READY",
"saasPortalUrl": "https://saas-portal.example.com",
"servicePlans": [{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
},
{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
],
"sourceEnvironmentID": "se-12345678",
"sourceEnvironmentName": "dev",
"type": "DEV",
"visibility": "private"
},
{"id": "se-12345678",
"name": "dev",
"promoteStatus": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"saasPortalStatus": "READY",
"saasPortalUrl": "https://saas-portal.example.com",
"servicePlans": [{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
},
{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
],
"sourceEnvironmentID": "se-12345678",
"sourceEnvironmentName": "dev",
"type": "DEV",
"visibility": "private"
},
{"id": "se-12345678",
"name": "dev",
"promoteStatus": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"saasPortalStatus": "READY",
"saasPortalUrl": "https://saas-portal.example.com",
"servicePlans": [{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
},
{"description": "A Basic product tier",
"modelType": "CUSTOMER_HOSTED",
"name": "Basic",
"productTierID": "pt-12345678",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
],
"sourceEnvironmentID": "se-12345678",
"sourceEnvironmentName": "dev",
"type": "DEV",
"visibility": "private"
}
],
"serviceLogoURL": "Quibusdam eaque tenetur commodi odio eligendi quas.",
"serviceProviderID": "sp-12345678",
"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
name	string Name of the Service
serviceLogoURL	string The logo for the service

Responses

Request samples

Payload

Content type

application/json

{"description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
"name": "MySQL multi-writer service",
"serviceLogoURL": "Non eum placeat omnis."
}

ServiceHealth service-api

Authorizations:

api_key_header_Authorization

path Parameters

id

required

string

Example: s-12345678

The ID of the service

Responses

Response samples

200

Content type

application/json

{"health": "UP",
"id": "s-12345678",
"report": {"se-12345678": {"sm-12345678": {"vu-11111111": "UNKNOWN",
"vu-12345678": "UP",
"vu-87654321": "DOWN"
}
}
}
}

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

Payload

Content type

application/json

{"description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
"fileContent": "Maiores nam qui.",
"fileFormat": "text/plain",
"fileName": "mysql.yaml",
"name": "MySQL multi-writer service",
"serviceLogoURL": "http://hermiston.com/jamison.koelpin"
}

Response samples

200

Content type

application/json

"s-12345678"

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

Payload

Content type

application/json

{"configs": {"Placeat molestiae aperiam iusto.": "Vero quo harum dolorum consequatur ut quas."
},
"description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
"environment": "dev",
"environmentType": "DEV",
"fileContent": "Est velit et.",
"name": "MySQL multi-writer service",
"release": true,
"releaseAsPreferred": true,
"releaseVersionName": "mysql",
"secrets": {"Et omnis itaque dignissimos.": "Voluptate nostrum et omnis.",
"Ipsa quos iure rerum sunt adipisci.": "Dolor voluptatibus maxime."
},
"serviceLogoURL": "http://mitchelllindgren.com/colt"
}

Response samples

200

Content type

application/json

{"productTierID": "pt-12345678",
"serviceEnvironmentID": "se-12345678",
"serviceID": "s-12345678",
"undefinedResources": {"mysql": "r-12345678"
}
}

BuildServiceFromServicePlanSpec service-api

Authorizations:

api_key_header_Authorization

Request Body schema: application/json
required

description	string A brief description of the service
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
name required	string Name of the Service
serviceLogoURL	string <uri> The logo for the service

Responses

Request samples

Payload

Content type

application/json

{"description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
"environment": "dev",
"environmentType": "DEV",
"fileContent": "Itaque dicta excepturi.",
"name": "MySQL multi-writer service",
"serviceLogoURL": "http://kassulke.org/linda"
}

Response samples

200

Content type

application/json

{"productTierID": "pt-12345678",
"serviceEnvironmentID": "se-12345678",
"serviceID": "s-12345678",
"undefinedResources": {"mysql": "r-12345678"
}
}

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

200

Content type

application/json

{"ids": ["se-12345678",
"se-23456789"
],
"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

Payload

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",
"type": "DEV",
"visibility": "Et qui."
}

Response samples

200

Content type

application/json

"se-12345678"

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

200

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",
"saasPortalStatus": "READY",
"saasPortalUrl": "https://saas-portal.example.com",
"serviceAuthPublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
"serviceId": "s-12345678",
"sourceEnvironmentId": "se-12345678",
"type": "DEV",
"visibility": "Non asperiores."
}

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

Payload

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": "Dicta culpa."
}

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

200

Content type

application/json

[{"status": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"targetEnvironmentID": "se-12345678"
},
{"status": "IN_SYNC|OUT_OF_SYNC|UNKNOWN",
"targetEnvironmentID": "se-12345678"
}
]

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

Responses

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

Payload

Content type

application/json

{"accountConfigIds": ["ac-12345678",
"ac-23456789"
],
"description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
"features": [{"configuration": {"Modi nam minima voluptatibus error.": "Accusantium aut."
},
"feature": "Ut ut non impedit optio eum velit."
},
{"configuration": {"Modi nam minima voluptatibus error.": "Accusantium aut."
},
"feature": "Ut ut non impedit optio eum velit."
},
{"configuration": {"Modi nam minima voluptatibus error.": "Accusantium aut."
},
"feature": "Ut ut non impedit optio eum velit."
}
],
"modelType": "CUSTOMER_HOSTED",
"name": "MySQL multi-writer service hosted model",
"serviceApiId": "sa-12345678"
}

Response samples

200

Content type

application/json

"sm-12345678"

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

200

Content type

application/json

{"accountConfigIds": ["ac-12345678",
"ac-23456789"
],
"activeAccountConfigIds": {"aws": "ac-12345678",
"gcp": "ac-23456789"
},
"description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
"features": [{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
}
],
"id": "sm-12345678",
"key": "mysql-multi-writer-service-hosted-model",
"modelType": "CUSTOMER_HOSTED",
"name": "MySQL multi-writer service hosted model",
"productTiers": ["pt-12345678",
"pt-87654321"
],
"serviceApiId": "sa-12345678",
"serviceId": "s-12345678"
}

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

Payload

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

Payload

Content type

application/json

{"accountConfigId": "ac-12345678"
}

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

Payload

Content type

application/json

{"accountConfigId": "ac-12345678"
}

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

Payload

Content type

application/json

{"feature": "Est dolores odit magni et mollitia quibusdam."
}

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

Payload

Content type

application/json

{"configuration": {"Vero ea expedita exercitationem.": "Expedita voluptatibus."
},
"feature": "Et quo blanditiis deserunt sed."
}

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

200

Content type

application/json

{"status": "READY"
}

CopyServiceModel service-model-api

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

Payload

Content type

application/json

{"accountConfigIds": ["ac-12345678",
"ac-23456789"
],
"description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
"features": [{"configuration": {"Modi nam minima voluptatibus error.": "Accusantium aut."
},
"feature": "Ut ut non impedit optio eum velit."
},
{"configuration": {"Modi nam minima voluptatibus error.": "Accusantium aut."
},
"feature": "Ut ut non impedit optio eum velit."
}
],
"name": "MySQL multi-writer service hosted model",
"targetServiceModelType": "CUSTOMER_HOSTED",
"targetTierType": "OMNISTRATE_DEDICATED_TENANCY"
}

Response samples

200

Content type

application/json

"sm-12345678"

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

200

Content type

application/json

{"ids": ["sm-12345678",
"sm-87654321"
],
"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

200

Content type

application/json

{"ids": ["Officiis qui totam id adipisci ducimus dicta.",
"Sit expedita qui earum qui accusamus.",
"Error dolorem qui.",
"Aliquam voluptas voluptas facere dignissimos quae assumenda."
],
"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

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	any Pricing
serviceModelId required	string Service model ID
support	string Support
tierType required	string Tier type

Responses

Request samples

Payload

Content type

application/json

{"awsRegions": ["us-east-2",
"ca-central-1"
],
"description": "A premium product tier",
"documentation": "Any documentation",
"gcpRegions": ["us-central1"
],
"isDisabled": false,
"name": "Premium",
"planDescription": "A premium plan",
"pricing": {"price1": "value1"
},
"serviceModelId": "sm-12345678",
"support": "Any support",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}

Response samples

200

Content type

application/json

"pt-12345678"

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

200

Content type

application/json

{"apiGroups": {"r-12345678": "v1",
"r-23456789": "v2",
"r-34567890": "v3"
},
"awsRegions": ["us-east-2",
"ca-central-1"
],
"description": "A premium product tier",
"documentation": "Any documentation",
"enabledFeatures": [{"configuration": {"provider": "native"
},
"feature": "LOGS",
"scope": "INTERNAL"
},
{"configuration": {"provider": "native"
},
"feature": "LOGS",
"scope": "INTERNAL"
},
{"configuration": {"provider": "native"
},
"feature": "LOGS",
"scope": "INTERNAL"
}
],
"features": {"BILLING": false,
"LOGS": true,
"METRICS": false
},
"gcpRegions": ["us-central1"
],
"id": "pt-12345678",
"isDisabled": false,
"key": "premium",
"name": "Premium",
"planDescription": "A premium plan",
"pricing": {"price1": "value1"
},
"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 Example: s-12345678 Service ID
id required	string 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	any Pricing
support	string Support
tierType	string Tier type

Responses

Request samples

Payload

Content type

application/json

{"awsRegions": ["us-east-2",
"ca-central-1"
],
"description": "A premium product tier",
"documentation": "Any documentation",
"gcpRegions": ["us-central1"
],
"isDisabled": false,
"name": "Premium",
"planDescription": "A premium plan",
"pricing": {"price1": "value1"
},
"support": "Any support",
"tierType": "OMNISTRATE_DEDICATED_TENANCY"
}

ListProductTierBillingPlan 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

Response samples

200

Content type

application/json

{"billingPlans": [{"allowCreatesWhenPaymentNotConfigured": true,
"id": "bp-12345678",
"maxNumberofInstances": 5,
"planName": "STARTER",
"pricing": {"cpuCoreHours": "0.001",
"memoryGiBHours": "0.0001",
"storageGiBHours": "0.0001"
},
"productTierId": "pt-12345678",
"serviceId": "s-12345678"
},
{"allowCreatesWhenPaymentNotConfigured": true,
"id": "bp-12345678",
"maxNumberofInstances": 5,
"planName": "STARTER",
"pricing": {"cpuCoreHours": "0.001",
"memoryGiBHours": "0.0001",
"storageGiBHours": "0.0001"
},
"productTierId": "pt-12345678",
"serviceId": "s-12345678"
}
]
}

CreateProductTierBillingPlan 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 required	boolean Allow creates when payment not configured
maxNumberofInstances required	integer <int64> Maximum number of instances
planName required	string Plan name
pricing required	any Pricing in dollars.

Responses

Request samples

Payload

Content type

application/json

{"allowCreatesWhenPaymentNotConfigured": true,
"maxNumberofInstances": 5,
"planName": "STARTER",
"pricing": {"cpuCoreHours": "0.001",
"memoryGiBHours": "0.0001",
"storageGiBHours": "0.0001"
}
}

Response samples

200

Content type

application/json

{"allowCreatesWhenPaymentNotConfigured": true,
"id": "bp-12345678",
"maxNumberofInstances": 5,
"planName": "STARTER",
"pricing": {"cpuCoreHours": "0.001",
"memoryGiBHours": "0.0001",
"storageGiBHours": "0.0001"
},
"productTierId": "pt-12345678",
"serviceId": "s-12345678"
}

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

Payload

Content type

application/json

{"feature": "BILLING",
"scope": "INTERNAL"
}

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

Payload

Content type

application/json

{"configuration": {"S3BucketArn": "arn:aws:s3:::my_billing_bucket_name"
},
"feature": "BILLING",
"scope": "INTERNAL"
}

DeleteProductTierBillingPlan product-tier-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
id required	string Example: bp-12345678 Product tier billing plan ID

Responses

DescribeProductTierBillingPlan product-tier-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
id required	string Example: bp-12345678 Product tier billing plan ID

Responses

Response samples

200

Content type

application/json

{"allowCreatesWhenPaymentNotConfigured": true,
"id": "bp-12345678",
"maxNumberofInstances": 5,
"planName": "STARTER",
"pricing": {"cpuCoreHours": "0.001",
"memoryGiBHours": "0.0001",
"storageGiBHours": "0.0001"
},
"productTierId": "pt-12345678",
"serviceId": "s-12345678"
}

UpdateProductTierBillingPlan product-tier-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
id required	string 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	any Pricing in dollars.

Responses

Request samples

Payload

Content type

application/json

{"allowCreatesWhenPaymentNotConfigured": true,
"maxNumberofInstances": 5,
"planName": "STARTER",
"pricing": {"cpuCoreHours": "0.001",
"memoryGBHours": "0.0001"
}
}

Response samples

200

Content type

application/json

{"allowCreatesWhenPaymentNotConfigured": true,
"id": "bp-12345678",
"maxNumberofInstances": 5,
"planName": "STARTER",
"pricing": {"cpuCoreHours": "0.001",
"memoryGiBHours": "0.0001",
"storageGiBHours": "0.0001"
},
"productTierId": "pt-12345678",
"serviceId": "s-12345678"
}

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

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	any Pricing
serviceModelId required	string Service model ID
support	string Support
targetTierType	string Tier type

Responses

Request samples

Payload

Content type

application/json

{"awsRegions": ["us-east-2",
"ca-central-1"
],
"description": "A premium product tier",
"documentation": "Any documentation",
"gcpRegions": ["us-central1"
],
"name": "Premium",
"planDescription": "A premium plan",
"pricing": {"price1": "value1"
},
"serviceModelId": "sm-12345678",
"support": "Any support",
"targetTierType": "OMNISTRATE_DEDICATED_TENANCY"
}

Response samples

200

Content type

application/json

"pt-12345678"

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

Payload

Content type

application/json

{"description": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
"serviceEnvironmentId": "se-12345678"
}

Response samples

200

Content type

application/json

"sa-12345678"

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

200

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

Payload

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

200

Content type

application/json

{"id": "sa-12345678",
"resourceChangeSets": {"Ipsam maiores.": {"categorizedResourceChanges": {"Libero et deleniti et facilis exercitationem.": {"changes": [{"attributes": {"resourceId": "r-12345678"
},
"changeType": "PENDING_NEW",
"name": "Customer metrics"
},
{"attributes": {"resourceId": "r-12345678"
},
"changeType": "PENDING_NEW",
"name": "Customer metrics"
},
{"attributes": {"resourceId": "r-12345678"
},
"changeType": "PENDING_NEW",
"name": "Customer metrics"
}
],
"status": "PENDING_UPDATE"
}
},
"imageConfigChanges": {"changeState": "PENDING_NEW",
"imageConfigId": "imgc-12345678",
"imageName": "mysql"
},
"infraConfigChanges": {"changeState": "PENDING_NEW",
"infraConfigId": "ic-12345678",
"name": "MySQL Writer Infra Config"
},
"overallResourceStatus": "PENDING_UPDATE",
"productTierFeatureChanges": "PENDING_UPDATE",
"resourceChanges": "PENDING_DELETE",
"resourceName": "Alias labore delectus quae sit error."
},
"Quaerat quisquam molestias nam dolor id vitae.": {"categorizedResourceChanges": {"Libero et deleniti et facilis exercitationem.": {"changes": [{"attributes": {"resourceId": "r-12345678"
},
"changeType": "PENDING_NEW",
"name": "Customer metrics"
},
{"attributes": {"resourceId": "r-12345678"
},
"changeType": "PENDING_NEW",
"name": "Customer metrics"
},
{"attributes": {"resourceId": "r-12345678"
},
"changeType": "PENDING_NEW",
"name": "Customer metrics"
}
],
"status": "PENDING_UPDATE"
}
},
"imageConfigChanges": {"changeState": "PENDING_NEW",
"imageConfigId": "imgc-12345678",
"imageName": "mysql"
},
"infraConfigChanges": {"changeState": "PENDING_NEW",
"infraConfigId": "ic-12345678",
"name": "MySQL Writer Infra Config"
},
"overallResourceStatus": "PENDING_UPDATE",
"productTierFeatureChanges": "PENDING_UPDATE",
"resourceChanges": "PENDING_DELETE",
"resourceName": "Alias labore delectus quae sit error."
}
},
"serviceId": "s-12345678"
}

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

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

Payload

Content type

application/json

{"isPreferred": true,
"productTierId": "pt-12345678",
"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

200

Content type

application/json

{"ids": ["sa-12345678"
],
"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

Responses

Response samples

200

Content type

application/json

{"nextPageToken": "next-token",
"servicePlans": [{"AutoApproveSubscription": false,
"accountConfigIds": ["ac-12345678",
"ac-23456789"
],
"activeAccountConfigIds": {"aws": "ac-12345678",
"gcp": "ac-23456789"
},
"apiVersion": "v1",
"awsRegions": ["us-east-2",
"ca-central-1"
],
"deploymentConfigId": "dc-12345678",
"gcpRegions": ["us-central1"
],
"hasPendingChanges": true,
"isProductTierDisabled": true,
"latestMajorVersion": "3.0",
"modelType": "CUSTOMER_HOSTED",
"productTierDescription": "A premium product tier",
"productTierDocumentation": "Any documentation",
"productTierFeatures": {"BILLING": false,
"LOGS": true,
"METRICS": false
},
"productTierId": "pt-12345678",
"productTierKey": "premium",
"productTierName": "Premium",
"productTierPlanDescription": "A premium plan",
"productTierPricing": {"price1": "value1"
},
"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",
"serviceModelFeatures": [{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
}
],
"serviceModelId": "sm-12345678",
"serviceModelName": "MySQL multi-writer service hosted model",
"tierType": "OMNISTRATE_DEDICATED_TENANCY",
"versionSetStatus": "Preferred|Active|Deprecated|Pending"
},
{"AutoApproveSubscription": false,
"accountConfigIds": ["ac-12345678",
"ac-23456789"
],
"activeAccountConfigIds": {"aws": "ac-12345678",
"gcp": "ac-23456789"
},
"apiVersion": "v1",
"awsRegions": ["us-east-2",
"ca-central-1"
],
"deploymentConfigId": "dc-12345678",
"gcpRegions": ["us-central1"
],
"hasPendingChanges": true,
"isProductTierDisabled": true,
"latestMajorVersion": "3.0",
"modelType": "CUSTOMER_HOSTED",
"productTierDescription": "A premium product tier",
"productTierDocumentation": "Any documentation",
"productTierFeatures": {"BILLING": false,
"LOGS": true,
"METRICS": false
},
"productTierId": "pt-12345678",
"productTierKey": "premium",
"productTierName": "Premium",
"productTierPlanDescription": "A premium plan",
"productTierPricing": {"price1": "value1"
},
"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",
"serviceModelFeatures": [{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
}
],
"serviceModelId": "sm-12345678",
"serviceModelName": "MySQL multi-writer service hosted model",
"tierType": "OMNISTRATE_DEDICATED_TENANCY",
"versionSetStatus": "Preferred|Active|Deprecated|Pending"
},
{"AutoApproveSubscription": false,
"accountConfigIds": ["ac-12345678",
"ac-23456789"
],
"activeAccountConfigIds": {"aws": "ac-12345678",
"gcp": "ac-23456789"
},
"apiVersion": "v1",
"awsRegions": ["us-east-2",
"ca-central-1"
],
"deploymentConfigId": "dc-12345678",
"gcpRegions": ["us-central1"
],
"hasPendingChanges": true,
"isProductTierDisabled": true,
"latestMajorVersion": "3.0",
"modelType": "CUSTOMER_HOSTED",
"productTierDescription": "A premium product tier",
"productTierDocumentation": "Any documentation",
"productTierFeatures": {"BILLING": false,
"LOGS": true,
"METRICS": false
},
"productTierId": "pt-12345678",
"productTierKey": "premium",
"productTierName": "Premium",
"productTierPlanDescription": "A premium plan",
"productTierPricing": {"price1": "value1"
},
"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",
"serviceModelFeatures": [{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
}
],
"serviceModelId": "sm-12345678",
"serviceModelName": "MySQL multi-writer service hosted model",
"tierType": "OMNISTRATE_DEDICATED_TENANCY",
"versionSetStatus": "Preferred|Active|Deprecated|Pending"
}
]
}

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

200

Content type

application/json

{"AutoApproveSubscription": false,
"accountConfigIds": ["ac-12345678",
"ac-23456789"
],
"activeAccountConfigIds": {"aws": "ac-12345678",
"gcp": "ac-23456789"
},
"apiVersion": "v1",
"awsRegions": ["us-east-2",
"ca-central-1"
],
"deploymentConfigId": "dc-12345678",
"gcpRegions": ["us-central1"
],
"hasPendingChanges": true,
"isProductTierDisabled": true,
"latestMajorVersion": "3.0",
"modelType": "CUSTOMER_HOSTED",
"productTierDescription": "A premium product tier",
"productTierDocumentation": "Any documentation",
"productTierFeatures": {"BILLING": false,
"LOGS": true,
"METRICS": false
},
"productTierId": "pt-12345678",
"productTierKey": "premium",
"productTierName": "Premium",
"productTierPlanDescription": "A premium plan",
"productTierPricing": {"price1": "value1"
},
"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",
"serviceModelFeatures": [{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
},
{"configuration": {"Facere accusantium ut saepe ipsum.": "Asperiores exercitationem accusantium perspiciatis vel qui."
},
"feature": "Aut illum quia non molestiae aut."
}
],
"serviceModelId": "sm-12345678",
"serviceModelName": "MySQL multi-writer service hosted model",
"tierType": "OMNISTRATE_DEDICATED_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=Qui ipsam placeat deserunt natus. Product tier version of the instance to describe. If not specified, the latest version is described.

Responses

Response samples

200

Content type

application/json

{"ids": ["r-12345678",
"r-abcdefgh",
"r-1234abcd"
],
"nextPageToken": "next-token",
"resources": [{"actionHooks": [{"command": "curl -v -X POST https://$HOSTNAME:8080/cluster/init",
"scope": "CLUSTER",
"type": "INIT"
}
],
"additionalSecurityContext": {"AddCapabilities": ["CAP_NET_ADMIN",
"CAP_NET_RAW"
],
"DropCapabilities": ["CAP_NET_ADMIN",
"CAP_NET_RAW"
],
"SupplementalGroupIDs": [1001,
999
]
},
"backupConfiguration": {"backupPeriodInHours": 24,
"backupRetentionInDays": 7
},
"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"customLabels": {"key": "value"
},
"customSysCTLs": {"net.ipv4.tcp_syncookies": "1"
},
"customULimits": [{"ULimitsName": "NoProc",
"ULimitsType": "Soft",
"ULimitsValue": 1000
},
{"ULimitsName": "NoFile",
"ULimitsType": "Hard",
"ULimitsValue": 2048
}
],
"dependencies": [{"parameterMap": {"clusterId": "writerId",
"clusterOrg": "userDatabase"
},
"resourceId": "r-12345678"
},
{"parameterMap": {"clusterId": "readerId",
"clusterOrg": "userDatabase"
},
"resourceId": "r-abcdef12"
}
],
"description": "An resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
"environmentVariables": [{"name": "MYSQL_ROOT_PASSWORD",
"value": "password"
}
],
"fileSystemConfiguration": {"EFSFileSystemConfiguration": {"PerformanceMode": "generalPurpose|maxIO",
"ProvisionedThroughputInMibps": 125,
"ThroughputMode": "provisioned|bursting|elastic"
}
},
"helmChartConfiguration": {"chartName": "my-chart",
"chartRepoName": "my-repo",
"chartRepoUrl": "https://my-repo.com",
"chartValues": {"key1": "value1",
"key2": 3,
"key3": {"key4": "value4"
}
},
"chartVersion": "1.0.0"
},
"id": "r-12345678",
"imageConfigId": "imgc-12345678",
"infraConfigId": "ic-12345678",
"internal": false,
"isDeprecated": true,
"key": "galera",
"kustomizeConfiguration": {"gitConfiguration": {"accessToken": "my-token",
"referenceName": "tags/v1.0.0",
"repositoryUrl": "https://github.com/username/myrepo",
"userName": "my-user"
},
"helmChartDependencies": [{"chartName": "cert-manager",
"chartVersion": "v1.5.3"
},
{"chartName": "nginx-ingress",
"chartVersion": "v0.48.1"
},
{"chartName": "external-dns",
"chartVersion": "v0.7.0"
},
{"chartName": "cnpg-operator",
"chartVersion": "v0.23.1"
}
],
"kustomizePath": "/kustomize"
},
"l4LoadBalancerConfiguration": {"ingressPortConfiguration": [{"associatedResourceIDs": ["r-12345678",
"r-abcdef12"
],
"backendPort": 8080,
"ingressPort": 1234
},
{"associatedResourceIDs": ["r-12345678",
"r-abcdef12"
],
"backendPort": 8081,
"ingressPort": 5678
},
{"associatedResourceIDs": ["r-vwxybz12",
"r-poij122v"
],
"backendPort": 8082,
"ingressPort": 9012
}
]
},
"l7LoadBalancerConfiguration": {"paths": [{"associatedResourceID": "r-12345678",
"path": "/path",
"port": 8080
}
]
},
"name": "Galera",
"operatorCRDConfiguration": {"helmChartDependencies": [{"chartName": "cert-manager",
"chartVersion": "v1.5.3"
},
{"chartName": "nginx-ingress",
"chartVersion": "v0.48.1"
},
{"chartName": "external-dns",
"chartVersion": "v0.7.0"
},
{"chartName": "cnpg-operator",
"chartVersion": "v0.23.1"
}
],
"outputParameters": {"expiresAt": "$out.status.notAfter",
"issuerName": "letsencrypt-prod"
},
"readinessConditions": {"$out.status.conditions[?(@.type=='Ready')].status": true
},
"supplementalFiles": ["apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n  name: letsencrypt-prod\nspec:\n  acme:\n    server: https://acme-v02.api.letsencrypt.org/directory\n",
"apiVersion: ingress.nginx.io/v1\nkind: IngressClass\nmetadata:\n  name: nginx\nspec:\n  controller: nginx.org/ingress-controller"
],
"template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n  name: letsencrypt-prod\nspec:\n  acme:\n    server: https://acme-v02.api.letsencrypt.org/directory\n    email: test@example.com\n    privateKeySecretRef:\n      name: letsencrypt-prod\n    solvers:\n    - http01:\n        ingress:\n          class: nginx"
},
"productTierId": "pt-12345678",
"proxyType": "PortsBasedProxy",
"resourceType": "Generic",
"serviceId": "s-12345678",
"terraformConfigurations": {"Dolorem aperiam consequatur quasi.": {"gitConfiguration": {"accessToken": "my-token",
"referenceName": "tags/v1.0.0",
"repositoryUrl": "https://github.com/username/myrepo",
"userName": "my-user"
},
"terraformPath": "/project1/tf"
}
}
},
{"actionHooks": [{"command": "curl -v -X POST https://$HOSTNAME:8080/cluster/init",
"scope": "CLUSTER",
"type": "INIT"
}
],
"additionalSecurityContext": {"AddCapabilities": ["CAP_NET_ADMIN",
"CAP_NET_RAW"
],
"DropCapabilities": ["CAP_NET_ADMIN",
"CAP_NET_RAW"
],
"SupplementalGroupIDs": [1001,
999
]
},
"backupConfiguration": {"backupPeriodInHours": 24,
"backupRetentionInDays": 7
},
"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"customLabels": {"key": "value"
},
"customSysCTLs": {"net.ipv4.tcp_syncookies": "1"
},
"customULimits": [{"ULimitsName": "NoProc",
"ULimitsType": "Soft",
"ULimitsValue": 1000
},
{"ULimitsName": "NoFile",
"ULimitsType": "Hard",
"ULimitsValue": 2048
}
],
"dependencies": [{"parameterMap": {"clusterId": "writerId",
"clusterOrg": "userDatabase"
},
"resourceId": "r-12345678"
},
{"parameterMap": {"clusterId": "readerId",
"clusterOrg": "userDatabase"
},
"resourceId": "r-abcdef12"
}
],
"description": "An resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
"environmentVariables": [{"name": "MYSQL_ROOT_PASSWORD",
"value": "password"
}
],
"fileSystemConfiguration": {"EFSFileSystemConfiguration": {"PerformanceMode": "generalPurpose|maxIO",
"ProvisionedThroughputInMibps": 125,
"ThroughputMode": "provisioned|bursting|elastic"
}
},
"helmChartConfiguration": {"chartName": "my-chart",
"chartRepoName": "my-repo",
"chartRepoUrl": "https://my-repo.com",
"chartValues": {"key1": "value1",
"key2": 3,
"key3": {"key4": "value4"
}
},
"chartVersion": "1.0.0"
},
"id": "r-12345678",
"imageConfigId": "imgc-12345678",
"infraConfigId": "ic-12345678",
"internal": false,
"isDeprecated": true,
"key": "galera",
"kustomizeConfiguration": {"gitConfiguration": {"accessToken": "my-token",
"referenceName": "tags/v1.0.0",
"repositoryUrl": "https://github.com/username/myrepo",
"userName": "my-user"
},
"helmChartDependencies": [{"chartName": "cert-manager",
"chartVersion": "v1.5.3"
},
{"chartName": "nginx-ingress",
"chartVersion": "v0.48.1"
},
{"chartName": "external-dns",
"chartVersion": "v0.7.0"
},
{"chartName": "cnpg-operator",
"chartVersion": "v0.23.1"
}
],
"kustomizePath": "/kustomize"
},
"l4LoadBalancerConfiguration": {"ingressPortConfiguration": [{"associatedResourceIDs": ["r-12345678",
"r-abcdef12"
],
"backendPort": 8080,
"ingressPort": 1234
},
{"associatedResourceIDs": ["r-12345678",
"r-abcdef12"
],
"backendPort": 8081,
"ingressPort": 5678
},
{"associatedResourceIDs": ["r-vwxybz12",
"r-poij122v"
],
"backendPort": 8082,
"ingressPort": 9012
}
]
},
"l7LoadBalancerConfiguration": {"paths": [{"associatedResourceID": "r-12345678",
"path": "/path",
"port": 8080
}
]
},
"name": "Galera",
"operatorCRDConfiguration": {"helmChartDependencies": [{"chartName": "cert-manager",
"chartVersion": "v1.5.3"
},
{"chartName": "nginx-ingress",
"chartVersion": "v0.48.1"
},
{"chartName": "external-dns",
"chartVersion": "v0.7.0"
},
{"chartName": "cnpg-operator",
"chartVersion": "v0.23.1"
}
],
"outputParameters": {"expiresAt": "$out.status.notAfter",
"issuerName": "letsencrypt-prod"
},
"readinessConditions": {"$out.status.conditions[?(@.type=='Ready')].status": true
},
"supplementalFiles": ["apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n  name: letsencrypt-prod\nspec:\n  acme:\n    server: https://acme-v02.api.letsencrypt.org/directory\n",
"apiVersion: ingress.nginx.io/v1\nkind: IngressClass\nmetadata:\n  name: nginx\nspec:\n  controller: nginx.org/ingress-controller"
],
"template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n  name: letsencrypt-prod\nspec:\n  acme:\n    server: https://acme-v02.api.letsencrypt.org/directory\n    email: test@example.com\n    privateKeySecretRef:\n      name: letsencrypt-prod\n    solvers:\n    - http01:\n        ingress:\n          class: nginx"
},
"productTierId": "pt-12345678",
"proxyType": "PortsBasedProxy",
"resourceType": "Generic",
"serviceId": "s-12345678",
"terraformConfigurations": {"Dolorem aperiam consequatur quasi.": {"gitConfiguration": {"accessToken": "my-token",
"referenceName": "tags/v1.0.0",
"repositoryUrl": "https://github.com/username/myrepo",
"userName": "my-user"
},
"terraformPath": "/project1/tf"
}
}
}
]
}

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 (BackupConfiguration)
	object Custom labels for the resource
	object Custom sysctl settings for the resource
	Array of objects (CustomULimits) Custom ulimits for the resource
description required	string A brief description of the resource
	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
key	string The key of the resource
	object (KustomizeConfiguration)
	object (L4LoadBalancerConfiguration)
	object (L7LoadBalancerConfiguration)
name required	string Name of the resource
	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

Payload

Content type

application/json

{"additionalSecurityContext": {"AddCapabilities": ["CAP_NET_ADMIN",
"CAP_NET_RAW"
],
"DropCapabilities": ["CAP_NET_ADMIN",
"CAP_NET_RAW"
],
"SupplementalGroupIDs": [1001,
999
]
},
"backupConfiguration": {"backupPeriodInHours": 24,
"backupRetentionInDays": 7
},
"customLabels": {"key": "value"
},
"customSysCTLs": {"net.ipv4.tcp_syncookies": "1"
},
"customULimits": [{"ULimitsName": "NoProc",
"ULimitsType": "Soft",
"ULimitsValue": 1000
},
{"ULimitsName": "NoFile",
"ULimitsType": "Hard",
"ULimitsValue": 2048
}
],
"description": "A resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
"environmentVariables": [{"key": "MYSQL_ROOT_PASSWORD",
"value": "password"
}
],
"fileSystemConfiguration": {"EFSFileSystemConfiguration": {"PerformanceMode": "generalPurpose|maxIO",
"ProvisionedThroughputInMibps": 125,
"ThroughputMode": "provisioned|bursting|elastic"
}
},
"helmChartConfiguration": {"chartName": "my-chart",
"chartRepoName": "my-repo",
"chartRepoUrl": "https://my-repo.com",
"chartValues": {"key1": "value1",
"key2": 3,
"key3": {"key4": "value4"
}
},
"chartVersion": "1.0.0"
},
"imageConfigId": "imgc-12345678",
"infraConfigId": "ic-12345678",
"internal": true,
"isProxy": true,
"key": "galera",
"kustomizeConfiguration": {"gitConfiguration": {"accessToken": "my-token",
"referenceName": "tags/v1.0.0",
"repositoryUrl": "https://github.com/username/myrepo",
"userName": "my-user"
},
"helmChartDependencies": [{"chartName": "cert-manager",
"chartVersion": "v1.5.3"
},
{"chartName": "nginx-ingress",
"chartVersion": "v0.48.1"
},
{"chartName": "external-dns",
"chartVersion": "v0.7.0"
},
{"chartName": "cnpg-operator",
"chartVersion": "v0.23.1"
}
],
"kustomizePath": "/kustomize"
},
"l4LoadBalancerConfiguration": {"ingressPortConfiguration": [{"associatedResourceIDs": ["r-12345678",
"r-abcdef12"
],
"backendPort": 8080,
"ingressPort": 1234
},
{"associatedResourceIDs": ["r-12345678",
"r-abcdef12"
],
"backendPort": 8081,
"ingressPort": 5678
},
{"associatedResourceIDs": ["r-vwxybz12",
"r-poij122v"
],
"backendPort": 8082,
"ingressPort": 9012
}
]
},
"l7LoadBalancerConfiguration": {"paths": [{"associatedResourceID": "r-12345678",
"path": "/path",
"port": 8080
}
]
},
"name": "Galera",
"operatorCRDConfiguration": {"helmChartDependencies": [{"chartName": "cert-manager",
"chartVersion": "v1.5.3"
},
{"chartName": "nginx-ingress",
"chartVersion": "v0.48.1"
},
{"chartName": "external-dns",
"chartVersion": "v0.7.0"
},
{"chartName": "cnpg-operator",
"chartVersion": "v0.23.1"
}
],
"outputParameters": {"expiresAt": "$out.status.notAfter",
"issuerName": "letsencrypt-prod"
},
"readinessConditions": {"$out.status.conditions[?(@.type=='Ready')].status": true
},
"supplementalFiles": ["apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n  name: letsencrypt-prod\nspec:\n  acme:\n    server: https://acme-v02.api.letsencrypt.org/directory\n",
"apiVersion: ingress.nginx.io/v1\nkind: IngressClass\nmetadata:\n  name: nginx\nspec:\n  controller: nginx.org/ingress-controller"
],
"template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n  name: letsencrypt-prod\nspec:\n  acme:\n    server: https://acme-v02.api.letsencrypt.org/directory\n    email: test@example.com\n    privateKeySecretRef:\n      name: letsencrypt-prod\n    solvers:\n    - http01:\n        ingress:\n          class: nginx"
},
"productTierId": "pt-12345678",
"proxyType": "PortsBasedProxy",
"resourceDependencies": [{"parameterMap": {"userDatabase": "clusterOrg",
"writerId": "clusterWriterId"
},
"resourceId": "r-12345678"
},
{"parameterMap": {"readerId": "clusterReaderId",
"userDatabase": "clusterOrg"
},
"resourceId": "r-abcdef12"
}
],
"resourceType": "Generic",
"terraformConfigurations": {"Et esse.": {"gitConfiguration": {"accessToken": "my-token",
"referenceName": "tags/v1.0.0",
"repositoryUrl": "https://github.com/username/myrepo",
"userName": "my-user"
},
"terraformPath": "/project1/tf"
}
}
}

Response samples

200

Content type

application/json

"r-12345678"

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

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=Dolores officia aut. Product tier version of the resource to describe. If not specified, the latest version is described.
ProductTierId	string Example: ProductTierId=Beatae beatae. ProductTierId of the resource to describe. Needs to specified in combination with the product tier version

Responses

Response samples

200

Content type

application/json

{"actionHooks": [{"command": "curl -v -X POST https://$HOSTNAME:8080/cluster/init",
"scope": "CLUSTER",
"type": "INIT"
}
],
"additionalSecurityContext": {"AddCapabilities": ["CAP_NET_ADMIN",
"CAP_NET_RAW"
],
"DropCapabilities": ["CAP_NET_ADMIN",
"CAP_NET_RAW"
],
"SupplementalGroupIDs": [1001,
999
]
},
"backupConfiguration": {"backupPeriodInHours": 24,
"backupRetentionInDays": 7
},
"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4

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

global-api

registrationServiceHealth global-api

Responses

Response samples

consumptionServiceHealth global-api

Responses

Response samples

consumptionServiceVersion global-api

Responses

Response samples

registrationServiceVersion global-api

Responses

Response samples

service-api

ListService service-api

Authorizations:

Responses

Response samples

CreateService service-api

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

DeleteService service-api

Authorizations:

path Parameters

Responses

DescribeService service-api

Authorizations:

path Parameters

Responses

Response samples

UpdateService service-api

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

ServiceHealth service-api

Authorizations:

path Parameters

Responses

Response samples

CreateServiceFromComposeSpec service-api

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

BuildServiceFromComposeSpec service-api

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

BuildServiceFromServicePlanSpec service-api

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

service-environment-api

ListServiceEnvironment service-environment-api

Authorizations:

path Parameters

Responses

Response samples

CreateServiceEnvironment service-environment-api

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

DeleteServiceEnvironment service-environment-api

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required