API docs by Redocly

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

Download OpenAPI specification:

REST API for Omnistrate Fleet

cost-api

The cost API provides insights into the cost of operating a fleet

DescribeCloudProviderCost cost-api

Get the total cost of operating a fleet on a cloud provider

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

The start date of the range

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

The end date of the range

environmentType
required
string
Example: environmentType=DEV

The type of environment to filter costs by

frequency
required
string
Example: frequency=DAILY|MONTHLY

The frequency of the cost data

includeCloudProviderIDs
string
Example: includeCloudProviderIDs=infra-12345678,infra-23456789

The cloud provider IDs to include in the cost data

excludeCloudProviderIDs
string
Example: excludeCloudProviderIDs=infra-12345678,infra-23456789

The cloud provider IDs to exclude from the cost data

Responses

Response samples

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

DescribeDeploymentCellCost cost-api

Get the total cost of operating a fleet in a deployment cell

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

The start date of the range

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

The end date of the range

environmentType
required
string
Example: environmentType=DEV

The type of environment to filter costs by

frequency
required
string
Example: frequency=DAILY|MONTHLY

The frequency of the cost data

includeCloudProviderIDs
string
Example: includeCloudProviderIDs=infra-12345678,infra-23456789

The cloud provider IDs to include in the cost data

excludeCloudProviderIDs
string
Example: excludeCloudProviderIDs=infra-12345678,infra-23456789

The cloud provider IDs to exclude from the cost data

includeRegionIDs
string
Example: includeRegionIDs=region-12345678,region-23456789

The region IDs to include in the cost data

excludeRegionIDs
string
Example: excludeRegionIDs=region-12345678,region-23456789

The region IDs to exclude from the cost data

includeDeploymentCellIDs
string
Example: includeDeploymentCellIDs=hc-12345678,hc-23456789

The deployment cell IDs to include in the cost data

excludeDeploymentCellIDs
string
Example: excludeDeploymentCellIDs=hc-12345678,hc-23456789

The deployment cell IDs to exclude from the cost data

includeInstanceIDs
string
Example: includeInstanceIDs=instance-12345678,instance-23456789

The instance IDs to include in the cost data

excludeInstanceIDs
string
Example: excludeInstanceIDs=instance-12345678,instance-23456789

The instance IDs to exclude from the cost data

topNInstances
integer <int64>
Example: topNInstances=10

The number of top instances to include in the cost data

Responses

Response samples

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

DescribeRegionCost cost-api

Get the total cost of operating a fleet in a region

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

The start date of the range

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

The end date of the range

environmentType
required
string
Example: environmentType=DEV

The type of environment to filter costs by

frequency
required
string
Example: frequency=DAILY|MONTHLY

The frequency of the cost data

includeCloudProviderIDs
string
Example: includeCloudProviderIDs=infra-12345678,infra-23456789

The cloud provider IDs to include in the cost data

excludeCloudProviderIDs
string
Example: excludeCloudProviderIDs=infra-12345678,infra-23456789

The cloud provider IDs to exclude from the cost data

includeRegionIDs
string
Example: includeRegionIDs=region-12345678,region-23456789

The region IDs to include in the cost data

excludeRegionIDs
string
Example: excludeRegionIDs=region-12345678,region-23456789

The region IDs to exclude from the cost data

Responses

Response samples

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

DescribeUserCost cost-api

Get the total cost of operating a fleet for a user

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

The start date of the range

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

The end date of the range

environmentType
required
string
Example: environmentType=DEV

The type of environment to filter costs by

includeUserIDs
string
Example: includeUserIDs=user-12345678,user-23456789

The user IDs to include in the cost data

excludeUserIDs
string
Example: excludeUserIDs=user-23456789

The user IDs to exclude from the cost data

topNUsers
integer <int64>
Example: topNUsers=10

The number of top users to include in the cost data

topNInstances
integer <int64>
Example: topNInstances=10

The number of top instances to include in the cost data

Responses

Response samples

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

fleet-workflows-api

The set of APIs that manage service workflows.

ListWorkflowExecutions fleet-workflows-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

verb
string
Example: verb=PostgresVersion

Filter executions by the provider-defined verb

status
string
Example: status=SUCCEEDED

Filter executions by status

startDate
string <date-time>
Example: startDate=2023-01-01T10:00:00Z

Start date of the executions

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

End date of the executions

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "executions": [
    ],
  • "instanceId": "instance-12345678",
  • "nextPageToken": "token",
  • "serviceId": "s-123456"
}

ListServiceWorkflows fleet-workflows-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

instanceId
string
Example: instanceId=instance-12345678

The instance ID of the workflow

startDate
string <date-time>
Example: startDate=2023-01-01T10:00:00Z

Start date of the workflows

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

End date of the workflows

excludeStats
boolean
Example: excludeStats=true

Whether to exclude expensive stats (e.g. per-workflow resource count) from the response.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "nextPageToken": "token",
  • "serviceId": "s-123456",
  • "workflows": [
    ]
}

DescribeServiceWorkflowSummary fleet-workflows-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

Responses

Response samples

Content type
application/json
{
  • "ActiveWorkflowCount": 3640577044318975500,
  • "CompletedWorkflowCount": 7082830716534534000,
  • "FailedWorkflowCount": 3757094500752139000,
  • "environmentId": "se-123456",
  • "serviceId": "s-123456"
}

TerminateServiceWorkflow fleet-workflows-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: submit-create-instance-plan-instance-50h74sj46

ID of the ServiceWorkflow

Responses

Response samples

Content type
application/json
{
  • "ResourceCount": 5814133881203709000,
  • "UpdatedBy": "Anonymous",
  • "UpdatedReason": "Customer requested termination.",
  • "WorkflowType": "Service deployment.",
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "currentStateSummary": "Waiting on applykafka: manifest drift on /spec/kafka/resources (attempt 47).",
  • "endTime": "2020-01-01T00:01:00Z",
  • "gcpProjectID": "my-project",
  • "id": "submit-create-instance-plan-instance-50h74sj46",
  • "manualOverride": {
    },
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "orgName": "my-org",
  • "parentId": "Ut aliquam.",
  • "planType": "my-plan",
  • "servicePlanId": "pt-12345678",
  • "servicePlanName": "my-product-tier-plan",
  • "servicePlanVersion": "3.1",
  • "startTime": "2020-01-01T00:00:00Z",
  • "status": "IN_PROGRESS",
  • "tasks": [
    ]
}

DescribeServiceWorkflow fleet-workflows-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: submit-create-instance-plan-instance-50h74sj46

ID of the ServiceWorkflow

Responses

Response samples

Content type
application/json
{
  • "Resources": [
    ],
  • "Workflow": {
    },
  • "environmentId": "se-123456",
  • "serviceId": "s-123456"
}

UpdateServiceWorkflow fleet-workflows-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: submit-create-instance-plan-instance-50h74sj46

ID of the ServiceWorkflow

Request Body schema: application/json
required
status
required
string

Update the status of the workflow execution. You can pause, resume or retry a workflow.

Responses

Request samples

Content type
application/json
{
  • "status": "pause|resume|retry"
}

Response samples

Content type
application/json
{
  • "ResourceCount": 1885466695485891800,
  • "UpdatedBy": "Anonymous",
  • "UpdatedReason": "Customer requested termination.",
  • "WorkflowType": "Service deployment.",
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "currentStateSummary": "Waiting on applykafka: manifest drift on /spec/kafka/resources (attempt 47).",
  • "endTime": "2020-01-01T00:01:00Z",
  • "gcpProjectID": "my-project",
  • "id": "submit-create-instance-plan-instance-50h74sj46",
  • "manualOverride": {
    },
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "orgName": "my-org",
  • "parentId": "Non veniam et sed impedit.",
  • "planType": "my-plan",
  • "servicePlanId": "pt-12345678",
  • "servicePlanName": "my-product-tier-plan",
  • "servicePlanVersion": "3.1",
  • "startTime": "2020-01-01T00:00:00Z",
  • "status": "IN_PROGRESS",
  • "tasks": [
    ]
}

GetWorkflowEvents fleet-workflows-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: submit-create-instance-plan-instance-50h74sj46

ID of the ServiceWorkflow

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "id": "submit-create-instance-plan-instance-50h74sj46",
  • "resources": [
    ],
  • "serviceId": "s-123456"
}

DescribeWorkflowExecution fleet-workflows-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

executionId
required
string
Example: instance-x-cwt-123-1752700000

The workflow execution ID to describe.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "execution": {
    },
  • "serviceId": "s-123456"
}

inventory-api

The set of APIs manage the inventory for service providers.

DeleteAccountConfig inventory-api

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

Account Config ID to operate on

Responses

DescribeAccountConfig inventory-api

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

Account Config ID to operate on

Responses

Response samples

Content type
application/json
{
  • "awsAccountID": "123456789012",
  • "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
  • "awsCloudFormationNoLBTemplateURL": "https://s3.amazonaws.com/omnistrate-cloudformation/org-EUVvex3bVm/account-config-setup-template-no-lb-policy.yaml",
  • "awsCloudFormationTemplateURL": "https://s3.amazonaws.com/omnistrate-cloudformation/org-EUVvex3bVm/account-config-setup-template.yaml",
  • "azureBootstrapShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/azure-bootstrap.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "azureBootstrapUserClientID": "3ec55e76-d2be-46a6-80d2-10984e0e17a1",
  • "azureDisconnectShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/azure-disconnect.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "azureOffboardShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/azure-offboard.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
  • "azureTenantID": "12345678-1234-1234-1234-123456789012",
  • "byoaInstanceIDs": [
    ],
  • "byocOnPremInstallCommand": "bash -c 'd=$(mktemp -d) && curl -fsSL https://omnistrate.com/account-setup/byoc-onprem?account_config_id=ac-MOju2uwKM0 | tar -x -C \"$d\" && bash \"$d/install.sh\"'",
  • "byocOnPremUninstallCommand": "helm uninstall omnistrate-dataplane-agent -n dataplane-agent",
  • "cloudNativeNetworks": [
    ],
  • "cloudProviderId": "Ut voluptates voluptas harum odio.",
  • "customTags": [
    ],
  • "description": "An AWS account hosting multiple dev environments",
  • "gcpBootstrapShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/gcp-bootstrap.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "gcpDisconnectShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/gcp-disconnect.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "gcpOffboardShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/gcp-offboard.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "gcpProjectID": "my-project",
  • "gcpProjectNumber": "123456789012",
  • "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
  • "id": "Est repellendus rerum dignissimos sunt unde.",
  • "managedWorkloadIdentityStatuses": [
    ],
  • "name": "Dev AWS account",
  • "nebiusBindings": [
    ],
  • "nebiusTenantID": "tenant-e00ezh17k22wmwq5f0",
  • "ociBootstrapShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/oci-bootstrap.sh?account_config_id=ac-YpsR5dKPB6)\"",
  • "ociBootstrapUserID": "ocid1.user.oc1..aaaaaaaaa6kkllecgcpbqt3ejal7sq5ig7xcxz3pgvn3j2hb2wlu7ny4vpyq",
  • "ociDisconnectShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/oci-disconnect.sh?account_config_id=ac-YpsR5dKPB6)\"",
  • "ociDomainID": "ocid1.domain.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "ociOffboardShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/oci-offboard.sh?account_config_id=ac-YpsR5dKPB6)\"",
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "status": "PENDING|VERIFYING|READY|FAILED|DELETING|READY_TO_OFFBOARD",
  • "statusMessage": "Account is ready"
}

ListAccountConfigCloudNativeNetworks inventory-api

List all registered CloudNativeNetworks for an account configuration

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

Account Config ID to operate on

Responses

Response samples

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

ImportAccountConfigCloudNativeNetworkHostCluster inventory-api

Import a discovered host cluster from an imported cloud native network

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

Account Config ID to operate on

region
required
string
Example: us-east-1

The deployment region where the host cluster resides

cloudNativeNetworkId
required
string
Example: vpc-0abc123def456

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

hostClusterName
required
string
Example: existing-eks-cluster

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

Responses

Response samples

Content type
application/json
{
  • "created": true,
  • "hostClusterId": "Possimus odit alias."
}

ImportAccountConfigCloudNativeNetwork inventory-api

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

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

Account Config ID to operate on

region
required
string
Example: us-east-1

The deployment region whose validated subnetworks should be imported

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

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

Responses

Response samples

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

UnimportAccountConfigCloudNativeNetwork inventory-api

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

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

Account Config ID to operate on

region
required
string
Example: us-east-1

The deployment region whose cloud native network row should be unimported

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

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

Responses

Response samples

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

BulkImportAccountConfigCloudNativeNetworks inventory-api

Bulk import or unimport CloudNativeNetworks for deployments

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

Account Config ID to operate on

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

List of cloud native network operations to perform

Responses

Request samples

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

Response samples

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

SyncAccountConfigCloudNativeNetworks inventory-api

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

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

Account Config ID to operate on

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

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

Responses

Request samples

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

Response samples

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

ListAccountConfigs inventory-api

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

Cloud Provider name to filter on

Responses

Request samples

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

Response samples

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

ListAllInstancesInHostCluster inventory-api

Return all resource instances in the given host cluster

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterId
required
string
Example: hc-12345678

ID of the host cluster to list instances for

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

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

ListAllSnapshotsInHostCluster inventory-api

Return all instance snapshots in the given host cluster

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterId
required
string
Example: hc-12345678

ID of the host cluster to list snapshots for

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

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

ListAllOrganizations inventory-api

Authorizations:
api_key_header_Authorization
query Parameters
hasInvoice
boolean
Example: hasInvoice=true

Filter for organizations with invoices

hasInvoiceWithStatus
string
Example: hasInvoiceWithStatus=draft|open|paid|uncollectible|void

Filter for organizations with invoices with a specific status

hasInvoiceFromDate
string <date-time>
Example: hasInvoiceFromDate=2023-01-01T10:00:00Z

Filter for organizations with invoices from a specific date

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

Filter for organizations with invoices to a specific date

Responses

Response samples

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

DeleteProxyResourceInstance inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

id
required
string
Example: instance-abcd1234

The instance ID

Responses

CreateProxyResourceInstance inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

sourceResourceKey
required
string
Example: mysql

The serverless resource key

Request Body schema: application/json
required
cloud_provider
string

The cloud provider name

region
string

The region code

requestParams
any

The request parameters

Responses

Request samples

Content type
application/json
{
  • "cloud_provider": "aws",
  • "region": "us-east-1",
  • "requestParams": {
    }
}

Response samples

Content type
application/json
{
  • "id": "Enim quaerat occaecati."
}

AdoptResourceInstance inventory-api

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

Service ID

servicePlanID
required
string
Example: pt-12345678

The service plan ID

hostClusterID
required
string
Example: hc-12345678

The host cluster ID or key

primaryResourceKey
required
string
Example: mysql

The primary resource key to adopt. This is the top-level resource that will be managed by Omnistrate.

query Parameters
servicePlanVersion
string
Example: servicePlanVersion=1.0

The service plan version

subscriptionID
string
Example: subscriptionID=sub-12345678

The subscription ID of the resource instance

Request Body schema: application/json
required
object

The resource adoption configuration

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "Beatae qui numquam laboriosam facilis iusto."
}

CreateResourceInstance inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
serviceProviderId
required
string
Example: omnistrate

The service provider ID

serviceKey
required
string
Example: service-orchestration

The service name

serviceAPIVersion
required
string
Example: v1

The service API version

serviceEnvironmentKey
required
string
Example: dev

The service environment name

serviceModelKey
required
string
Example: hosted

The service model name

productTierKey
required
string
Example: premium

The product tier name

resourceKey
required
string
Example: mysql

The resource key

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

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

Request Body schema: application/json
required
cloud_provider
string

The cloud provider name

custom_network_id
string

Custom network for resource

Array of objects (CustomTag)

The custom tags for the resource instance.

externalPayerId
string

The external payer id to record which customer should pay for this resource instance. This will override the subscription level external payer id if set.

instanceId
string

The ID of a previously deleted instance to restore. When provided, the instance will be re-provisioned with the same ID.

network_type
string

The network type

onprem_platform
string

OnPrem platform

productTierVersion
string

The product tier version

region
string

The region code

requestParams
any

The request parameters

subscriptionId
string

The subscription ID

Array of objects (WorkflowBreakpoint)

The workflow breakpoints for the resource instance.

Responses

Request samples

Content type
application/json
{
  • "cloud_provider": "aws",
  • "custom_network_id": "n-1234567890",
  • "customTags": [
    ],
  • "externalPayerId": "external-billing-id-1234",
  • "instanceId": "instance-12345678",
  • "network_type": "PUBLIC|INTERNAL",
  • "onprem_platform": "OpenShift",
  • "productTierVersion": "1.0",
  • "region": "us-east-1",
  • "requestParams": {
    },
  • "subscriptionId": "Qui vel a ab soluta rerum.",
  • "workflowBreakpoints": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "Est hic reprehenderit laborum et."
}

SearchInventory inventory-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
object (SearchInventoryFilters)

Optional filters to apply to inventory search result categories.

query
required
string

The search query. Supports prefixed searches such as 'service:', 'user:', 'subscription:', 'deploymentcell:', 'serviceplan:', 'resource:', 'serverlessproxy:', 'resourceinstance:', 'snapshot:', 'notification:', 'workflow:', 'upgradepath:', 'all:'. Without a prefix, performs a text search across resource instances, notifications, and workflows.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "query": "snapshot:instance-12345678"
}

Response samples

Content type
application/json
{
  • "deploymentCellResults": [
    ],
  • "notificationResults": [
    ],
  • "proxyInstanceResults": [
    ],
  • "resourceInstanceResults": [
    ],
  • "resourceResults": [
    ],
  • "serverlessProxyResults": [
    ],
  • "servicePlanResults": [
    ],
  • "serviceResults": [
    ],
  • "snapshotResults": [
    ],
  • "subscriptionResults": [
    ],
  • "upgradePathResults": [
    ],
  • "userResults": [
    ],
  • "workflowResults": [
    ]
}

ListServiceOfferings inventory-api

Authorizations:
api_key_header_Authorization
query Parameters
visibility
string
Example: visibility=PRIVATE

The visibility of service offering

Responses

Response samples

Content type
application/json
{}

DescribeServiceOffering inventory-api

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

The service ID

query Parameters
visibility
string
Example: visibility=PRIVATE

The visibility of service offering

productTierId
string
Example: productTierId=pt-12345678

The product tier Id

productTierVersion
string
Example: productTierVersion=1.0.0

The product tier version

Responses

Response samples

Content type
application/json
{}

DescribeServiceOfferingResource inventory-api

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

The service ID

resourceId
required
string
Example: r-12345678

The resource ID

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

The instance ID

query Parameters
productTierId
string
Example: productTierId=pt-12345678

The product tier Id

productTierVersion
string
Example: productTierVersion=1.0.0

The product tier version

Responses

Response samples

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

UpdateAccountConfigResourceInstance inventory-api

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

The service ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

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

Full replacement set of custom tags for the backing account configuration

Array of objects (FleetUpdateAccountConfigNebiusBindingInput)

Full replacement set of Nebius bindings for this account config instance

setConnection
boolean

set account config instance connection

Responses

Request samples

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

RemoveCustomDNSFromResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

resourceKey
required
string
Example: http-service

The resource key

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Responses

AddCustomDNSToResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

resourceKey
required
string
Example: http-service

The resource key

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
customDNS
required
string

The custom DNS to add

targetPort
integer <int64>

The target port

Responses

Request samples

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

DescribeHostCluster inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: hc-12345678

The host cluster ID

Responses

Response samples

Content type
application/json
{
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "createdAt": "2021-01-01T00:00:00Z",
  • "dashboardEndpoint": "https://dashboard.example.com",
  • "deploymentInstancesTags": [
    ],
  • "gcpProjectID": "my-project",
  • "id": "Eveniet et amet dicta omnis.",
  • "isBYOCOnPrem": false,
  • "isOnPremDataplane": false,
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "privateLinkEnabled": false,
  • "region": "us-east-1",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "type": "Kubernetes"
}

GenerateTokenForHostClusterDashboard inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: hc-12345678

The host cluster ID

Responses

Response samples

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

ListHostClusters inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

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

DeleteResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
resourceId
required
string

The resource ID.

skipFinalSnapshot
boolean
Default: false

If true, skip the automatic final snapshot before deletion even if snapshotBeforeDeletion is enabled for the resource.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "Eos tempore non ut ut tenetur harum.",
  • "skipFinalSnapshot": false
}

DescribeResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

query Parameters
detail
boolean
Default: false
Example: detail=true

If true, the response will include detailed information about the resource instance.

Responses

Response samples

Content type
application/json
{
  • "activeBreakpoints": [
    ],
  • "adopted": true,
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "consumptionResourceInstanceResult": {
    },
  • "controlPlaneDeploymentCellID": "Voluptatem eos ducimus.",
  • "defaultSubscription": true,
  • "deploymentCellID": "Et repudiandae sunt labore nihil asperiores incidunt.",
  • "environmentId": "se-123456",
  • "gcpProjectID": "my-project",
  • "input_params": {
    },
  • "instanceDebugCommands": [
    ],
  • "integrationsStatus": [],
  • "launch_input_params": {
    },
  • "maintenanceTasks": {
    },
  • "managedResourceType": "PortsBasedProxy",
  • "manualOverride": {
    },
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "organizationId": "Impedit odit quam vero nihil ullam ad.",
  • "organizationName": "my-org",
  • "portsRegistrationStatus": {
    },
  • "productTierId": "Eos cum rerum.",
  • "productTierName": "premium",
  • "productTierType": "OMNISTRATE_DEDICATED",
  • "proxyType": "PortsBasedProxy",
  • "resourceId": "Dolor ipsa possimus veritatis possimus.",
  • "resourceName": "postgres",
  • "resourceVersionSummaries": [
    ],
  • "serviceEnvName": "dev",
  • "serviceId": "s-123456",
  • "serviceLogoURL": "Sed blanditiis.",
  • "serviceModelId": "Dignissimos natus quo et.",
  • "serviceModelName": "hosted",
  • "serviceModelType": "OMNISTRATE_HOSTED",
  • "serviceName": "mysql",
  • "subscriptionId": "Laboriosam saepe.",
  • "subscriptionOwnerName": "John Doe",
  • "subscriptionStatus": "ACTIVE|SUSPENDED|TERMINATED|CANCELLED",
  • "tierVersion": "1.0",
  • "tierVersionReleasedAt": "2020-01-01T00:00:00Z",
  • "tierVersionReleasedByUserId": "Corrupti qui natus.",
  • "tierVersionReleasedByUserName": "John Doe",
  • "tierVersionStatus": "Preferred|Active|Deprecated|Pending"
}

UpdateResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

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

The custom tags for the resource instance.

network_type
string

The network type

requestParams
any

The request parameters

resourceId
required
string

The resource ID.

Responses

Request samples

Content type
application/json
{
  • "customTags": [
    ],
  • "network_type": "PUBLIC|INTERNAL",
  • "requestParams": {
    },
  • "resourceId": "Aut dignissimos et aut doloribus."
}

AddCapacityToResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

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

Number of replicas to be added

resourceId
required
string

The resource ID.

Responses

Request samples

Content type
application/json
{
  • "capacityToBeAdded": 3,
  • "resourceId": "Ea aut."
}

TriggerAutomaticResourceInstanceSnapshotCreation inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "serviceId": "s-123456",
  • "snapshotId": "Ea incidunt officiis doloremque aliquam."
}

CopyResourceInstanceSnapshot inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
sourceSnapshotId
string

The source snapshot ID

targetRegion
required
string

The target region to copy the snapshot to

Responses

Request samples

Content type
application/json
{
  • "sourceSnapshotId": "Quibusdam ut nihil eum adipisci.",
  • "targetRegion": "us-west-2"
}

Response samples

Content type
application/json
{
  • "snapshotId": "Officiis suscipit omnis et."
}

ResourceInstanceCustomWorkflow inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

workflowId
required
string
Example: cwt-12345678

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

Request Body schema: application/json
required
requestParams
any

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

resourceId
required
string

The resource ID.

waitForCompletionSeconds
integer <int64>

Block up to N seconds (max 60) and return the completed execution inline. 0/absent = async.

Responses

Request samples

Content type
application/json
{
  • "requestParams": {
    },
  • "resourceId": "Sit laborum.",
  • "waitForCompletionSeconds": 30
}

Response samples

Content type
application/json
{
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "workflowExecutionId": "Voluptates architecto perferendis.",
  • "workflowId": "Facere voluptatem."
}

DebugResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Responses

Response samples

Content type
application/json
{
  • "instanceId": "instance-12345678",
  • "resourcesDebug": {
    }
}

UpdateResourceInstanceDebugMode inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
enable
required
boolean

Enable debug mode

Responses

Request samples

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

ListDependentComponents inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "nextPageToken": "next-token",
  • "resources": [
    ],
  • "serviceId": "s-123456"
}

DescribeInstanceEvent inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

id
required
string
Example: event-12345678

The ID of the event

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "eventSource": "Customer, Infra or Maintenance",
  • "id": "Odio ut repellat occaecati.",
  • "instanceId": "instance-12345678",
  • "message": "instance-abcd1234 created",
  • "orgId": "Tempore nisi commodi aut.",
  • "orgName": "Acme Corporation",
  • "resourceName": "Galera",
  • "serviceId": "s-123456",
  • "time": "2023-01-10T00:00:00Z",
  • "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:146.0) Gecko/20100101 Firefox/146.0",
  • "userId": "Et dolor corporis qui modi.",
  • "userName": "John Doe",
  • "workflowFailures": [
    ],
  • "workflowId": "Et hic rerum."
}

ListInstanceEvents inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

query Parameters
startTime
string
Example: startTime=2023-01-10T00:00:00Z

Filter events that occurred after this time

endTime
string
Example: endTime=2023-01-10T00:00:00Z

Filter events that occurred before this time

excludeWorkflowFailures
boolean
Example: excludeWorkflowFailures=true

Whether to exclude workflow failure details from the response.

Responses

Response samples

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

FailoverResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
failedReplicaAction
string

The failed replica action

failedReplicaID
required
string

The failed replica ID

Responses

Request samples

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

DescribeResourceInstanceInstaller inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Responses

Response samples

Content type
application/json
{
  • "installerURL": "Tempore sunt.",
  • "instanceId": "instance-12345678"
}

ListLinkedInstances inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

query Parameters
excludeNetworkTopology
boolean
Example: excludeNetworkTopology=false

Whether to exclude network topology details from the response.

excludeHAStatus
boolean
Example: excludeHAStatus=false

Whether to exclude high availability and autoscaling status from the response.

excludeIntegrations
boolean
Example: excludeIntegrations=false

Whether to exclude integration statuses from the response.

excludeMaintenanceTasks
boolean
Example: excludeMaintenanceTasks=false

Whether to exclude maintenance tasks from the response.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "nextPageToken": "next-token",
  • "resourceInstances": [
    ],
  • "serviceId": "s-123456"
}

UpdateResourceInstanceMetadata inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

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

The custom tags for the resource instance.

deletionProtection
boolean

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

enableDebugMode
boolean

Enable debug mode

Responses

Request samples

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

OneOffPatchResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
resourceId
required
string

The resource ID.

object

The resource override configuration for one-off patching.

targetTierVersion
string

The target resource version.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "Et quia.",
  • "resourceOverrideConfiguration": {
    },
  • "targetTierVersion": "2.0"
}

Response samples

Content type
application/json
{
  • "activeBreakpoints": [
    ],
  • "adopted": true,
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "consumptionResourceInstanceResult": {
    },
  • "controlPlaneDeploymentCellID": "Quae repudiandae ea et.",
  • "defaultSubscription": true,
  • "deploymentCellID": "Possimus omnis adipisci quis rerum libero.",
  • "environmentId": "se-123456",
  • "gcpProjectID": "my-project",
  • "input_params": {
    },
  • "instanceDebugCommands": [
    ],
  • "integrationsStatus": [],
  • "launch_input_params": {
    },
  • "maintenanceTasks": {
    },
  • "managedResourceType": "PortsBasedProxy",
  • "manualOverride": {
    },
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "organizationId": "Voluptas sed officia.",
  • "organizationName": "my-org",
  • "portsRegistrationStatus": {
    },
  • "productTierId": "Architecto magni omnis deserunt ut.",
  • "productTierName": "premium",
  • "productTierType": "OMNISTRATE_DEDICATED",
  • "proxyType": "PortsBasedProxy",
  • "resourceId": "Commodi inventore dolor maxime tempora.",
  • "resourceName": "postgres",
  • "resourceVersionSummaries": [
    ],
  • "serviceEnvName": "dev",
  • "serviceId": "s-123456",
  • "serviceLogoURL": "Error culpa atque repellat est itaque.",
  • "serviceModelId": "Deserunt pariatur laudantium aut impedit at.",
  • "serviceModelName": "hosted",
  • "serviceModelType": "OMNISTRATE_HOSTED",
  • "serviceName": "mysql",
  • "subscriptionId": "Et ipsum laboriosam id iste rem.",
  • "subscriptionOwnerName": "John Doe",
  • "subscriptionStatus": "ACTIVE|SUSPENDED|TERMINATED|CANCELLED",
  • "tierVersion": "1.0",
  • "tierVersionReleasedAt": "2020-01-01T00:00:00Z",
  • "tierVersionReleasedByUserId": "Deleniti sed voluptatem nulla consequatur eos ipsam.",
  • "tierVersionReleasedByUserName": "John Doe",
  • "tierVersionStatus": "Preferred|Active|Deprecated|Pending"
}

RemoveCapacityFromResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

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

Number of replicas to be removed

resourceId
required
string

The resource ID.

Responses

Request samples

Content type
application/json
{
  • "capacityToBeRemoved": 3,
  • "resourceId": "Enim autem."
}

RestartResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
resourceId
required
string

The resource ID.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "Voluptatem mollitia qui aut adipisci autem aperiam."
}

DescribeResourceInstanceSnapshotFromTime inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
targetRestoreTime
required
string

The target restore time

Responses

Request samples

Content type
application/json
{
  • "targetRestoreTime": "2021-09-01T00:00:00Z"
}

Response samples

Content type
application/json
{
  • "completeTime": "2021-09-01T00:00:00Z",
  • "environmentId": "se-123456",
  • "productTierId": "Qui nihil.",
  • "productTierVersion": "1.0",
  • "serviceId": "s-123456",
  • "snapshotId": "Pariatur non.",
  • "status": "completed"
}

RestoreResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
network_type
string

The network type

targetRestoreTime
required
string

The target restore time

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "Quisquam temporibus."
}

ListResourceInstanceSnapshots inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Responses

Response samples

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

CreateResourceInstanceSnapshot inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
targetRegion
string

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "serviceId": "s-123456",
  • "snapshotId": "Deleniti qui omnis nemo ratione repellendus."
}

DescribeResourceInstanceSnapshot inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

snapshotId
required
string
Example: instance-ss-12345678

The instance snapshot ID

Responses

Response samples

Content type
application/json
{
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "completeTime": "2021-09-01T00:00:00Z",
  • "createdTime": "2021-09-01T00:00:00Z",
  • "encrypted": true,
  • "environmentId": "se-123456",
  • "environmentName": "Production",
  • "environmentType": "PROD",
  • "instanceResourceType": "OperatorCRD",
  • "outputParams": [
    ],
  • "productTierId": "Est qui tempora commodi ipsam.",
  • "productTierName": "Premium",
  • "productTierVersion": "1.0",
  • "productTierVersionDescription": "Version 1.0",
  • "progress": 99,
  • "region": "us-west-2",
  • "serviceId": "s-123456",
  • "serviceName": "Postgres",
  • "snapshotId": "Nihil nemo et.",
  • "snapshotMetadata": {
    },
  • "snapshotType": "AutomatedSnapshot|ManualSnapshot",
  • "sourceInstanceId": "instance-12345678",
  • "status": "completed",
  • "subscriptionId": "Quaerat ut occaecati eos nemo excepturi.",
  • "subscriptionOwnerOrgId": "Laborum ullam aut.",
  • "subscriptionOwnerOrgName": "Example Inc.",
  • "subscriptionOwnerUserId": "Officia quo quis cupiditate debitis optio iure.",
  • "subscriptionOwnerUserName": "Admin"
}

StartResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
resourceId
required
string

The resource ID.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "Voluptatibus quia qui minus est repellat omnis."
}

StopResourceInstance inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

Request Body schema: application/json
required
resourceId
required
string

The resource ID.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "Qui reiciendis."
}

ListInstanceUpgradeHistory inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "instanceId": "instance-12345678",
  • "nextPageToken": "next-token",
  • "serviceId": "s-123456",
  • "upgrades": [
    ]
}

ListResourceInstances inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

query Parameters
ProductTierVersion
string
Example: ProductTierVersion=Est et.

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

ProductTierId
string
Example: ProductTierId=Est corporis quia.

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

SubscriptionId
string
Example: SubscriptionId=Quia et quaerat dolor facere.

Subscription id of the instance to describe.

Filter
string
Enum: "onlyCloudAccounts" "excludeCloudAccounts"
Example: Filter=onlyCloudAccounts

Filter to apply to the list of instances.

ExcludeDetail
boolean
Default: false
Example: ExcludeDetail=true

Whether to exclude detailed information about the resource instances.

excludeNetworkTopology
boolean
Example: excludeNetworkTopology=false

Whether to exclude network topology details from the response.

excludeHAStatus
boolean
Example: excludeHAStatus=false

Whether to exclude high availability and autoscaling status from the response.

excludeIntegrations
boolean
Example: excludeIntegrations=false

Whether to exclude integration statuses from the response.

excludeMaintenanceTasks
boolean
Example: excludeMaintenanceTasks=false

Whether to exclude maintenance tasks from the response.

nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "nextPageToken": "next-token",
  • "resourceInstances": [
    ],
  • "serviceId": "s-123456"
}

DescribeResource inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

serviceModelId
required
string
Example: sm-12345678

The service model ID.

productTierId
required
string
Example: pt-12345678

The product tier ID.

resourceId
required
string
Example: r-12345678

The resource ID.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "instanceCount": 2,
  • "name": "asserts-server",
  • "perVersionInstanceCount": {
    },
  • "productTierType": "OMNISTRATE_DEDICATED",
  • "proxyType": "PortsBasedProxy",
  • "resourceId": "Quod est autem nihil nostrum quisquam.",
  • "serviceId": "s-123456",
  • "serviceModelType": "OMNISTRATE_HOSTED",
  • "supportsPublicNetwork": true,
  • "version": "2.0",
  • "versionHistory": [
    ]
}

ListResources inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

serviceModelId
required
string
Example: sm-12345678

The service model ID.

productTierId
required
string
Example: pt-12345678

The product tier ID.

Request Body schema: application/json
required
environmentType
string

Filter resources by environment type.

nextPageToken
string

Token to use for the next request

orgId
string

Filter resources by organization ID.

pageSize
integer <int64>

The number of resources to return per page.

userId
string

Filter resources by user ID.

Responses

Request samples

Content type
application/json
{
  • "environmentType": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "nextPageToken": "next-token",
  • "orgId": "Nostrum facilis autem.",
  • "pageSize": 10,
  • "userId": "Dolor est pariatur animi provident impedit labore."
}

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "nextPageToken": "next-token",
  • "resources": [
    ],
  • "serviceId": "s-123456"
}

DescribeOrganization inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

organizationId
required
string
Example: o-12345678

The organization ID.

Responses

Response samples

Content type
application/json
{
  • "email": "omnistrate-devops@examplecorp.com",
  • "orgId": "Suscipit eum enim voluptas molestias aliquam.",
  • "orgName": "Acme Corp",
  • "orgUrl": "omnistrate.com"
}

ListActiveOrganizations inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "nextPageToken": "next-token",
  • "organizations": [
    ],
  • "serviceId": "s-123456"
}

InvokeResourceInstanceWorkflowVerb inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

instanceId
required
string
Example: instance-12345678

The resource instance ID.

verb
required
string
Example: PostgresVersion

The provider-defined verb to invoke. The server resolves the verb to a custom workflow ID against the instance's plan version.

Request Body schema: application/json
required
requestParams
any

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

resourceId
required
string

The resource ID.

waitForCompletionSeconds
integer <int64>

Block up to N seconds (max 60) and return the completed execution inline. 0/absent = async.

Responses

Request samples

Content type
application/json
{
  • "requestParams": {
    },
  • "resourceId": "Natus sed modi fugit.",
  • "waitForCompletionSeconds": 30
}

Response samples

Content type
application/json
{
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "workflowExecutionId": "Ex perferendis et error temporibus non ut.",
  • "workflowId": "Perspiciatis fugit et eum."
}

SearchServiceInventory inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

Request Body schema: application/json
required
query
required
string

The search query. Supports prefixed searches such as 'user:', 'org:', 'image:', 'infra:', 'sc:', 'sci:', 'snapshot:'. Without a prefix, performs a general text search.

Responses

Request samples

Content type
application/json
{
  • "query": "snapshot:instance-12345678"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "serviceId": "s-123456"
}

DescribeInventorySummary inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

Responses

Response samples

Content type
application/json
{
  • "EnvironmentCount": 1,
  • "ImagesCount": 1,
  • "InfraConfigCount": 1,
  • "InstancesCount": 1,
  • "OrganizationCount": 1,
  • "ResourceCount": 1,
  • "UserCount": 1,
  • "environmentId": "se-123456",
  • "serviceId": "s-123456"
}

ListAllResourceInstanceSnapshots inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

query Parameters
productTierId
string
Example: productTierId=Est corporis quia.

The product tier id to filter by

subscriptionId
string
Example: subscriptionId=Quia et quaerat dolor facere.

The subscription id to filter by

snapshotType
string
Example: snapshotType=AutomatedSnapshot|ManualSnapshot

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

Responses

Response samples

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

DeleteResourceInstanceSnapshot inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

snapshotId
required
string
Example: instance-ss-12345678

The instance snapshot ID

Responses

RestoreResourceInstanceFromSnapshot inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

snapshotId
required
string
Example: instance-ss-12345678

The snapshot ID

Request Body schema: application/json
required
custom_network_id
string

Custom network for resource

inputParametersOverride
any

Custom input parameters override

network_type
string

The network type

productTierVersionOverride
string

The product tier version

restoreToSourceInstance
boolean

If true, restore to the same instance ID as the previously deleted source instance. This preserves the original instance ID and endpoint.

subscriptionId
string

The target subscription ID. If omitted, restores to the snapshot's original subscription. Cross-subscription restore is only supported for service provider hosted deployments on the same service, product tier, and host cluster.

Responses

Request samples

Content type
application/json
{
  • "custom_network_id": "n-1234567890",
  • "inputParametersOverride": {
    },
  • "network_type": "PUBLIC|INTERNAL",
  • "productTierVersionOverride": "1.0",
  • "restoreToSourceInstance": false,
  • "subscriptionId": "Similique eum aut modi qui tempore."
}

Response samples

Content type
application/json
{
  • "id": "Neque nobis aut magni eaque."
}

ListSubscription inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

query Parameters
productTierId
string
Example: productTierId=pt-12345678

The product tier Id

includeInactive
boolean
Example: includeInactive=false

Whether to include inactive subscriptions

excludePricing
boolean
Example: excludePricing=false

Whether to exclude billing details from the response

excludeStats
boolean
Example: excludeStats=false

Whether to exclude subscription statistics from the response

nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

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

CreateSubscriptionOnBehalfOfCustomer inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
boolean

Whether to allow creating instances when payment is not configured.

billingProvider
string

The billing provider for this subscription

customPrice
boolean

Whether to use a custom price for this subscription

object

If customPrice is true, provide the price per unit for the subscription here.

externalPayerId
string

The external payer ID to record which customer should pay for this subscription

maxNumberOfInstances
integer <int64>

The maximum number of instances that can be created for this subscription. Use -1 to unset this restriction.

onBehalfOfCustomerUserId
required
string

The user ID of the customer that this subscription is on behalf of

priceEffectiveDate
string

The effective date of the price, truncated to the first day of the month. Only the current or future months may be specified.

productTierId
required
string

The product tier ID

Responses

Request samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "billingProvider": "STRIPE|BRING_YOUR_OWN",
  • "customPrice": true,
  • "customPricePerUnit": {
    },
  • "externalPayerId": "a3df-sdf9-gfn3-4g3f",
  • "maxNumberOfInstances": 10,
  • "onBehalfOfCustomerUserId": "Expedita quas in ut eaque et nemo.",
  • "priceEffectiveDate": "2019-01-01T00:00:00Z",
  • "productTierId": "Mollitia sit non reprehenderit quisquam voluptas."
}

Response samples

Content type
application/json
{
  • "id": "Voluptatum ab rerum rem qui iste."
}

TerminateSubscription inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: sub-12345678

The subscription ID

Responses

DescribeSubscription inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: sub-12345678

The subscription ID

Responses

Response samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "billingProvider": "STRIPE|BRING_YOUR_OWN",
  • "createdAt": "2019-01-01T00:00:00Z",
  • "currentActivePricePerUnit": {
    },
  • "customPrice": true,
  • "externalPayerId": "a3df-sdf9-gfn3-4g3f",
  • "firstUsageTime": "2019-01-01T00:00:00Z",
  • "id": "Vel et possimus earum illo minus.",
  • "instanceCount": 3,
  • "maxNumberOfInstances": 10,
  • "productTierId": "Consequatur consequatur non et impedit.",
  • "productTierName": "Omnistrate Multi Tenancy",
  • "rootUserEmail": "abc@gmail.com",
  • "rootUserId": "Eos laborum.",
  • "rootUserName": "John Doe",
  • "rootUserOrgId": "Et illo est.",
  • "scheduledSubscriptionPricingList": [
    ],
  • "serviceId": "s-123456",
  • "serviceLogoURL": "Cum mollitia dolore quia est pariatur fugit.",
  • "serviceName": "MySQL multi-writer service",
  • "status": "ACTIVE|SUSPENDED|TERMINATED|CANCELLED",
  • "subscriptionPricingAuditLogs": [
    ],
  • "updatedAt": "2019-01-01T00:00:00Z",
  • "updatedByUserId": "Sed iure et beatae officia.",
  • "updatedByUserName": "John Doe",
  • "updatedByUserOrgId": "Modi doloremque.",
  • "userAttributes": {
    },
  • "userCount": 2
}

UpdateSubscription inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: sub-12345678

The subscription ID

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
boolean

Whether to allow creating instances when payment is not configured.

billingProvider
string

The billing provider for this subscription

customPrice
boolean

Whether to use a custom price for this subscription

object

If custom price is true, provide the price per unit for the subscription here.

externalPayerId
string

The external payer ID to record which customer should pay for this subscription.

maxNumberOfInstances
integer <int64>

The maximum number of instances that can be created for this subscription. Use -1 to unset this restriction.

priceEffectiveDate
string

The effective date of the price, truncated to the first day of the month. Only the current or future months may be specified.

Responses

Request samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "billingProvider": "STRIPE|BRING_YOUR_OWN",
  • "customPrice": true,
  • "customPricePerUnit": {
    },
  • "externalPayerId": "a3df-sdf9-gfn3-4g3f",
  • "maxNumberOfInstances": 10,
  • "priceEffectiveDate": "2019-01-01T00:00:00Z"
}

ResumeSubscription inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: sub-12345678

The subscription ID

Responses

SuspendSubscription inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: sub-12345678

The subscription ID

Responses

ListSubscriptionRequests inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

query Parameters
status
string
Example: status=PENDING

The status of the subscription request to filter by

Responses

Response samples

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

DenySubscriptionRequest inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: subr-12345678

The subscription ID

Responses

DescribeSubscriptionRequest inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: subr-12345678

The subscription ID

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-01-01T00:00:00Z",
  • "id": "Officia totam et est rerum.",
  • "productTierId": "Qui commodi eligendi natus.",
  • "productTierName": "Omnistrate Multi Tenancy",
  • "rootUserEmail": "abc@gmail.com",
  • "rootUserId": "Molestiae vel magnam ut saepe aliquam.",
  • "rootUserName": "John Doe",
  • "serviceId": "s-123456",
  • "serviceLogoURL": "Voluptatem magni.",
  • "serviceName": "MySQL multi-writer service",
  • "status": "PENDING|APPROVED|DENIED|CANCELLED",
  • "updatedAt": "2019-01-01T00:00:00Z",
  • "updatedByUserId": "Nemo laborum enim.",
  • "updatedByUserName": "John Doe"
}

ApproveSubscriptionRequest inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

id
required
string
Example: subr-12345678

The subscription ID

Responses

UpdateSubscriptions inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

Request Body schema: application/json
required
allowCreatesWhenPaymentNotConfigured
boolean

Whether to allow creating instances when payment is not configured.

billingProvider
string

The billing provider for this subscription

customPrice
boolean

Whether to use a custom price for this subscription

object

If customPrice is true, provide the price per unit for the subscription here.

externalPayerId
string

The external payer ID to record which customer should pay for this subscription.

maxNumberOfInstances
integer <int64>

The maximum number of instances that can be created for this subscription. Use -1 to unset this restriction.

priceEffectiveDate
string

The effective date of the price, truncated to the first day of the month. Only the current or future months may be specified.

subscriptionIDs
required
Array of strings

List of subscription IDs to update

Responses

Request samples

Content type
application/json
{
  • "allowCreatesWhenPaymentNotConfigured": true,
  • "billingProvider": "STRIPE|BRING_YOUR_OWN",
  • "customPrice": true,
  • "customPricePerUnit": {
    },
  • "externalPayerId": "a3df-sdf9-gfn3-4g3f",
  • "maxNumberOfInstances": 10,
  • "priceEffectiveDate": "2019-01-01T00:00:00Z",
  • "subscriptionIDs": [
    ]
}

DescribeUser inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

userId
required
string
Example: user-12345678

The user ID

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2021-01-01T00:00:00Z",
  • "email": "alice@enterprise.com",
  • "enabled": true,
  • "lastModifiedAt": "2021-01-01T00:00:00Z",
  • "lastModifiedByUserID": "Eius velit dolor eum.",
  • "lastModifiedByUserName": "Alice",
  • "orgId": "Magni consequuntur.",
  • "orgName": "Enterprise",
  • "orgUrl": "https://enterprise.com",
  • "status": "ACTIVE|NOT_ENABLED",
  • "subscriptions": [
    ],
  • "token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
  • "userId": "Omnis suscipit.",
  • "userName": "Alice"
}

ListUsers inventory-api

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

The service ID this workflow belongs to.

environmentId
required
string
Example: se-12345678

The service environment ID this workflow belongs to.

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

subscriptionId
string
Example: subscriptionId=sub-12345678

The subscription ID of the user

excludeStats
boolean
Example: excludeStats=false

Whether to exclude user statistics from the response

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "nextPageToken": "next-token",
  • "serviceId": "s-123456",
  • "users": [
    ]
}

CreateUpgradePath inventory-api

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

The service ID this workflow belongs to.

productTierId
required
string
Example: pt-12345678

The product tier ID that this upgrade path belongs to

Request Body schema: application/json
required
object

Configuration overrides for the upgrade path per adopted instance ID. This currently only includes custom Helm chart values and Helm runtime configurations.

maxConcurrentUpgrades
integer <int64>

The maximum number of instances that can be upgraded concurrently. If not specified, falls back to the deployment configuration setting.

notifyCustomer
boolean

Whether to notify the end customer about the upgrade progress.

scheduledDate
string

The future date when the upgrade is planned to be executed. Empty for immediate upgrade.

sourceVersion
required
string

The source version of the upgrade path.

targetVersion
required
string

The target version of the upgrade path.

required
object

The filter to use to choose the instances to upgrade.

Responses

Request samples

Content type
application/json
{
  • "configurationOverrides": {
    },
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "scheduledDate": "2020-01-01",
  • "sourceVersion": "1.0",
  • "targetVersion": "2.0",
  • "upgradeFilters": {
    }
}

Response samples

Content type
application/json
{
  • "completedAt": "2020-01-01T00:00:00Z",
  • "completedCount": 2,
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "failedCount": 4,
  • "failedInstanceReasons": {
    },
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Dolor est ad rerum.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Vitae magni occaecati.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "statusMessage": "Upgrade path auto-cancelled: paused for longer than 24h0m0s without being resumed",
  • "targetVersion": "2.0",
  • "targetVersionName": "Similique quisquam architecto.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Et ut pariatur rerum ea."
}

DescribeUpgradePath inventory-api

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

The service ID this workflow belongs to.

productTierId
required
string
Example: pt-12345678

The product tier ID that this upgrade path belongs to

upgradePathId
required
string
Example: up-12345678

The upgrade path ID

Responses

Response samples

Content type
application/json
{
  • "completedAt": "2020-01-01T00:00:00Z",
  • "completedCount": 2,
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "failedCount": 4,
  • "failedInstanceReasons": {
    },
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Fugiat et sapiente sit.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Incidunt a.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "statusMessage": "Upgrade path auto-cancelled: paused for longer than 24h0m0s without being resumed",
  • "targetVersion": "2.0",
  • "targetVersionName": "Quibusdam cumque ratione tenetur perferendis autem ut.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Dolor aut."
}

CancelUpgradePath inventory-api

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

The service ID this workflow belongs to.

productTierId
required
string
Example: pt-12345678

The product tier ID that this upgrade path belongs to

upgradePathId
required
string
Example: up-12345678

The upgrade path ID

Responses

Response samples

Content type
application/json
{
  • "completedAt": "2020-01-01T00:00:00Z",
  • "completedCount": 2,
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "failedCount": 4,
  • "failedInstanceReasons": {
    },
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Quia voluptates.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Aspernatur corporis vero sit.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "statusMessage": "Upgrade path auto-cancelled: paused for longer than 24h0m0s without being resumed",
  • "targetVersion": "2.0",
  • "targetVersionName": "Quae sed ipsa dolorem.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Consequatur omnis officia fugiat vero doloremque autem."
}

ListEligibleInstancesPerUpgrade inventory-api

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

The service ID this workflow belongs to.

productTierId
required
string
Example: pt-12345678

The product tier ID that this upgrade path belongs to

upgradePathId
required
string
Example: up-12345678

The upgrade path ID

query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ],
  • "nextPageToken": "next-token",
  • "productTierId": "Minus voluptatem quos fugiat.",
  • "serviceId": "s-123456",
  • "upgradePathId": "Nobis qui rem."
}

ManageUpgradePath inventory-api

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

The service ID this workflow belongs to.

productTierId
required
string
Example: pt-12345678

The product tier ID that this upgrade path belongs to

upgradePathId
required
string
Example: up-12345678

The upgrade path ID

Request Body schema: application/json
required
action
required
string

The action to perform on the upgrade path.

object

The action payload to perform on the upgrade path.

Responses

Request samples

Content type
application/json
{
  • "action": "pause|cancel|resume|skip-instances|notify-customer",
  • "actionPayload": {
    }
}

Response samples

Content type
application/json
{
  • "completedAt": "2020-01-01T00:00:00Z",
  • "completedCount": 2,
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "failedCount": 4,
  • "failedInstanceReasons": {
    },
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Et consequatur dolor ea.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Numquam tenetur harum.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "statusMessage": "Upgrade path auto-cancelled: paused for longer than 24h0m0s without being resumed",
  • "targetVersion": "2.0",
  • "targetVersionName": "Repellat hic dolore quae.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Nisi iusto quae ipsum quia."
}

ChangeUpgradePathTargetVersion inventory-api

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

The service ID this workflow belongs to.

productTierId
required
string
Example: pt-12345678

The product tier ID that this upgrade path belongs to

upgradePathId
required
string
Example: up-12345678

The upgrade path ID

Request Body schema: application/json
required
targetVersion
required
string

The new target product tier version for the scheduled upgrade path.

Responses

Request samples

Content type
application/json
{
  • "targetVersion": "2.0"
}

Response samples

Content type
application/json
{
  • "completedAt": "2020-01-01T00:00:00Z",
  • "completedCount": 2,
  • "createdAt": "2020-01-01T00:00:00Z",
  • "createdBy": "John Doe",
  • "failedCount": 4,
  • "failedInstanceReasons": {
    },
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Quia saepe tempora odit.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Eum velit exercitationem reprehenderit quis aliquam.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "statusMessage": "Upgrade path auto-cancelled: paused for longer than 24h0m0s without being resumed",
  • "targetVersion": "2.0",
  • "targetVersionName": "Eligendi et sit accusamus vel.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Quasi at ullam corrupti."
}

ListUpgradePaths inventory-api

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

The service ID this workflow belongs to.

productTierId
required
string
Example: pt-12345678

The product tier ID that this upgrade path belongs to

query Parameters
sourceProductTierVersion
string
Example: sourceProductTierVersion=1.0

The source product tier version to list upgrade paths for

targetProductTierVersion
string
Example: targetProductTierVersion=2.0

The target product tier version to list upgrade paths for

status
string
Example: status=COMPLETE

The status of the upgrade path to filter by

type
string
Example: type=Major

The type of the upgrade path to filter by

nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

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

ListServicesOrchestrations inventory-api

Authorizations:
api_key_header_Authorization
query Parameters
environmentType
required
string
Example: environmentType=PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL

The environment type

Responses

Response samples

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

CreateServicesOrchestration inventory-api

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

base64 encoded content of service orchestration create DSL

Responses

Request samples

Content type
application/json
{
  • "orchestrationCreateDSL": "Ea est culpa eaque."
}

Response samples

Content type
application/json
{
  • "id": "Impedit eveniet impedit dolor est qui veritatis."
}

DeleteServicesOrchestration inventory-api

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

The ID of the services orchestration

Responses

DescribeServicesOrchestration inventory-api

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

The ID of the services orchestration

Responses

Response samples

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

ModifyServicesOrchestration inventory-api

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

The ID of the services orchestration

Request Body schema: application/json
required
orchestrationModifyDSL
required
string

base64 encoded content of services orchestration modify DSL

Responses

Request samples

Content type
application/json
{
  • "orchestrationModifyDSL": "Id amet ea illo."
}

CreateConsumptionUser inventory-api

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

Additional attributes of the user.

companyUrl
string

Company URL of the user.

email
required
string <email> non-empty

Email address of the user

enableAutoVerification
required
boolean

Whether to enable auto verification for the user.

legalCompanyName
required
string non-empty

Legal company name of the user.

name
required
string non-empty

Name of the user

password
required
string non-empty

Password of the user

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "companyUrl": "https://mywebsite.com",
  • "email": "abc@gmail.com",
  • "enableAutoVerification": true,
  • "legalCompanyName": "mywebsite",
  • "name": "John Doe",
  • "password": "password"
}

Response samples

Content type
application/json
"Ipsum veniam quidem autem repellat quasi fuga."

DeleteUser inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
userId
required
string
Example: user-12345678

The user ID

Responses

DescribeOrgUser inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
userId
required
string
Example: user-12345678

The user ID

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2021-01-01T00:00:00Z",
  • "email": "alice@enterprise.com",
  • "enabled": true,
  • "lastModifiedAt": "2021-01-01T00:00:00Z",
  • "lastModifiedByUserID": "Doloribus voluptas qui.",
  • "lastModifiedByUserName": "Alice",
  • "orgId": "Eveniet quidem et.",
  • "orgName": "Enterprise",
  • "orgUrl": "https://enterprise.com",
  • "status": "ACTIVE|NOT_ENABLED",
  • "subscriptions": [
    ],
  • "token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
  • "userId": "Sit unde nemo.",
  • "userName": "Alice"
}

UpdateConsumptionUser inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
userId
required
string
Example: user-12345678

The user ID

Request Body schema: application/json
required
object

Additional attributes of the user.

Responses

Request samples

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

SuspendUser inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
userId
required
string
Example: user-12345678

The user ID

Responses

UnsuspendUser inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
userId
required
string
Example: user-12345678

The user ID

Responses

ResendVerificationEmail inventory-api

Authorizations:
api_key_header_Authorization
path Parameters
userId
required
string
Example: user-12345678

The user ID

Responses

ListAllUsers inventory-api

Authorizations:
api_key_header_Authorization
query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

serviceId
string
Example: serviceId=s-12345678

The service ID of the users

excludeStats
boolean
Example: excludeStats=false

Whether to exclude user statistics from the response

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "next-token",
  • "serviceId": "s-123456",
  • "users": [
    ]
}

hostcluster-api

The set of APIs manage the host clusters for service providers.

ListHostClusterEntities hostcluster-api

List the host cluster entities.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-12345abcd

ID of the host cluster whose entities are to be listed

entityType
required
string
Example: NAMESPACE

Type of entities to list (e.g., NAMESPACE, SERVICE, POD, etc.)

Responses

Response samples

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

DeleteEntity hostcluster-api

Delete a host cluster entity.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-12345abcd

ID of the host cluster to which the entity belongs

entityType
required
string
Example: NAMESPACE

Type of the entity (e.g., NAMESPACE, SERVICE, POD, etc.)

entityID
required
string
Example: namespace-12345

Unique identifier of the entity to delete

Responses

DescribeHostClusterEntity hostcluster-api

Retrieve the host cluster entity details.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-12345abcd

ID of the host cluster to which the entity belongs

entityType
required
string
Example: NAMESPACE

Type of the entity (e.g., NAMESPACE, SERVICE, POD, etc.)

entityID
required
string
Example: namespace-12345

Unique identifier of the entity to describe

Responses

Response samples

Content type
application/json
{
  • "identifier": "namespace-12345",
  • "properties": {
    },
  • "type": "NAMESPACE"
}

SetNodePoolProperty hostcluster-api

Set the node pool property.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-12345abcd

ID of the host cluster to which the entity belongs

nodePoolName
required
string
Example: nodepool-1

Unique identifier of the node pool to update

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

New maximum size for the node pool

Responses

Request samples

Content type
application/json
{
  • "maxSize": 10
}

TerminateDeploymentCellWorkflow hostcluster-api

Terminate a deployment cell workflow execution.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-abcdefgh

ID of the Host Cluster

workflowID
required
string
Example: redeploy-hc-abcdefgh

ID of the Deployment Cell Workflow

Responses

Response samples

Content type
application/json
{
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "currentStateSummary": "Waiting on redeploy: capacity error creating worker node.",
  • "deploymentCellId": "hc-abcdefgh",
  • "endTime": "2024-01-01T12:30:00Z",
  • "gcpProjectID": "my-project",
  • "hostClusterID": "hc-abcdefgh",
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "orgName": "my-org",
  • "parentId": "Amet voluptatibus cupiditate iure recusandae quis.",
  • "startTime": "2024-01-01T12:00:00Z",
  • "status": "COMPLETED",
  • "tasks": [
    ],
  • "workflowID": "redeploy-hc-abcdefgh",
  • "workflowType": "Service deployment."
}

DescribeDeploymentCellWorkflow hostcluster-api

Retrieve the deployment cell workflow details.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-abcdefgh

ID of the Host Cluster

workflowID
required
string
Example: redeploy-hc-abcdefgh

ID of the Deployment Cell Workflow

Responses

Response samples

Content type
application/json
{
  • "hostClusterID": "hc-abcdefgh",
  • "status": {
    },
  • "workflow": {
    },
  • "workflowID": "redeploy-hc-abcdefgh"
}

UpdateDeploymentCellWorkflow hostcluster-api

Update a deployment cell workflow execution. You can pause, resume or retry a workflow.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-abcdefgh

ID of the Host Cluster

workflowID
required
string
Example: redeploy-hc-abcdefgh

ID of the Deployment Cell Workflow

Request Body schema: application/json
required
status
required
string

Update the status of the deployment cell workflow execution. You can pause, resume or retry a workflow.

Responses

Request samples

Content type
application/json
{
  • "status": "pause|resume|retry"
}

Response samples

Content type
application/json
{
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "currentStateSummary": "Waiting on redeploy: capacity error creating worker node.",
  • "deploymentCellId": "hc-abcdefgh",
  • "endTime": "2024-01-01T12:30:00Z",
  • "gcpProjectID": "my-project",
  • "hostClusterID": "hc-abcdefgh",
  • "ociTenancyID": "ocid1.tenancy.oc1..aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  • "orgName": "my-org",
  • "parentId": "Deserunt quas iure.",
  • "startTime": "2024-01-01T12:00:00Z",
  • "status": "COMPLETED",
  • "tasks": [
    ],
  • "workflowID": "redeploy-hc-abcdefgh",
  • "workflowType": "Service deployment."
}

GetDeploymentCellWorkflowEvents hostcluster-api

Get events for a deployment cell workflow.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-abcdefgh

ID of the Host Cluster

workflowID
required
string
Example: redeploy-hc-abcdefgh

ID of the Deployment Cell Workflow

Responses

Response samples

Content type
application/json
{
  • "eventsPerWorkflowStep": [
    ],
  • "hostClusterID": "hc-abcdefgh",
  • "workflowID": "redeploy-hc-abcdefgh"
}

ListDeploymentCellWorkflows hostcluster-api

List the deployment cell workflows.

Authorizations:
api_key_header_Authorization
path Parameters
hostClusterID
required
string
Example: hc-abcdefgh

The host cluster ID to filter by

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

Start date of the workflows

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

End date of the workflows

nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

Responses

Response samples

Content type
application/json
{
  • "hostClusterID": "hc-abcdefgh",
  • "nextPageToken": "token",
  • "totalCount": 42,
  • "workflows": [
    ]
}

DeleteHostCluster hostcluster-api

Delete an empty host cluster.

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

ID of the host cluster to delete

Responses

DescribeHostCluster hostcluster-api

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

ID of the host cluster to describe

Responses

Response samples

Content type
application/json
{
  • "EnvironmentType": "PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL",
  • "accountConfigId": "Quia ipsa voluptatum.",
  • "accountID": "123456789012",
  • "amenities": [
    ],
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "createdAt": "2021-01-01T00:00:00Z",
  • "currentNumberOfDeployments": 2,
  • "currentNumberOfSnapshots": 5,
  • "customNetworkDetail": {
    },
  • "customerEmail": "admin@example.com",
  • "customerOrganizationName": "My Customer Organization",
  • "deploymentInstancesTags": [
    ],
  • "description": "My Host Cluster",
  • "hasPendingChanges": true,
  • "healthStatus": {
    },
  • "helmPackages": [
    ],
  • "id": "Sit minima recusandae ut.",
  • "intermediaryAccountDetail": {
    },
  • "isBYOCOnPrem": false,
  • "isCustomDeployment": true,
  • "isInSyncWithOrgTemplate": true,
  • "isOnPremDataplane": false,
  • "key": "my-host-cluster",
  • "kubernetesDashboardEndpoint": "https://my-k8s-dashboard.com",
  • "modelType": "OMNISTRATE_HOSTED|CUSTOMER_HOSTED|BYOA",
  • "pendingAmenities": [
    ],
  • "privateLinkEnabled": false,
  • "region": "us-east-1",
  • "regionId": "Sapiente provident qui soluta doloribus molestiae distinctio.",
  • "role": "Dataplane|Provisioner",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "type": "Kubernetes"
}

UpdateHostCluster hostcluster-api

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

ID of the host cluster to update

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

The pending amenities for the host cluster

syncWithOrgTemplate
boolean

Whether to sync the host cluster with the org template

Responses

Request samples

Content type
application/json
{
  • "pendingAmenities": [
    ],
  • "syncWithOrgTemplate": true
}

ApplyPendingChangesToHostCluster hostcluster-api

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

ID of the host cluster to apply pending changes to

Responses

CancelHostClusterDeployment hostcluster-api

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

ID of the host cluster where the deployment is located

Responses

GenerateTokenForHostClusterDashboard hostcluster-api

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

ID of the host cluster to delete

Responses

Response samples

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

DebugHostCluster hostcluster-api

Debug a host cluster.

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

ID of the host cluster to debug

query Parameters
includeAmenitiesInstallationLogs
boolean
Example: includeAmenitiesInstallationLogs=true

Include the installation logs of the amenities in the host cluster

Responses

Response samples

Content type
application/json
{
  • "amenityArtifacts": [
    ],
  • "amenityStatuses": [
    ],
  • "customHelmExecutionLogsBase64": {
    },
  • "template": {
    }
}

KubeConfigHostCluster hostcluster-api

Retrieve the kubeconfig for a host cluster.

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

ID of the host cluster to get the kubeconfig for

query Parameters
role
string
Default: "cluster-reader"
Example: role=cluster-admin|cluster-reader

The role of the service account to use for the kubeconfig

Responses

Response samples

Content type
application/json
{
  • "apiServerEndpoint": "https://api.my-host-cluster.com",
  • "caDataBase64": "base64-encoded-ca-data",
  • "clientCertificateDataBase64": "base64-encoded-client-certificate-data",
  • "clientKeyDataBase64": "base64-encoded-client-key-data",
  • "id": "Cumque voluptatum ut nihil animi aliquam.",
  • "serviceAccountToken": "base64-encoded-service-account-token",
  • "userName": "omnistrate-user"
}

RestartHostClusterDeployment hostcluster-api

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

ID of the host cluster where the deployment is located

Responses

AdoptHostCluster hostcluster-api

Adopt a self-managed host cluster.

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
cloudProvider
required
string
customerEmail
string

Email of the customer who owns the host cluster in case this is a BYOA host cluster

description
required
string non-empty

Description of the host cluster

id
required
string

ID of the host cluster to adopt

region
required
string

The actual region name of the host cluster

Responses

Request samples

Content type
application/json
{
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "customerEmail": "mycustomer@example.com",
  • "description": "My Adopted Host Cluster",
  • "id": "Reprehenderit dolorem.",
  • "region": "us-east-1"
}

Response samples

Content type
application/json
{
  • "adoptionStatus": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED",
  • "agentInstallationKit": "base64-encoded-tar-archive"
}

ListHostClusters hostcluster-api

Authorizations:
api_key_header_Authorization
query Parameters
accountConfigId
string
Example: accountConfigId=ac-12345678

The account config ID of the host cluster

regionId
string
Example: regionId=region-12345678

The region ID of the host cluster

includeProvisionerClusters
boolean
Example: includeProvisionerClusters=true

Whether to include provisioner clusters in the response

customerEmail
string
Example: customerEmail=admin@example.com

The email of the customer to filter host clusters by

Responses

Response samples

Content type
application/json
{
  • "hostClusters": [
    ],
  • "token": "qzf"
}

events-api

The set of APIs manage the events for service providers.

ListEvents events-api

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

The environment type to filter by

Responses

Response samples

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

AcknowledgeEvent events-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: e-123456

The ID of the event

Responses

audit-events-api

The set of APIs for auditing fleet events for service providers.

AuditEvents audit-events-api

Authorizations:
api_key_header_Authorization
query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

serviceID
string
Example: serviceID=s-123456

The service ID to list events for

environmentType
string
Example: environmentType=PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL

The type of service environment

eventSourceTypes
Array of strings
Example: eventSourceTypes=Voluptatem nihil soluta excepturi velit voluptas voluptatem.&eventSourceTypes=Odit nulla eos ea.&eventSourceTypes=Sint corporis itaque nulla.&eventSourceTypes=Quo quas molestias consequatur optio eos.

The event types to filter by

instanceID
string
Example: instanceID=instance-12345678

The instance ID to list events for

productTierID
string
Example: productTierID=Est corporis quia.

ID of a Product Tier

startDate
string <date-time>
Example: startDate=2023-01-01T10:00:00Z

Start date of the events

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

End date of the events

excludeWorkflowFailures
boolean
Example: excludeWorkflowFailures=true

Whether to exclude workflow failure details from the response.

userId
string
Example: userId=Fuga et natus.

The user ID to filter events by

orgId
string
Example: orgId=Blanditiis ipsam non perferendis magni occaecati non.

The organization ID to filter events by

subscriptionId
string
Example: subscriptionId=sub-abcd1234

The subscription ID to filter events by

ipAddress
string
Example: ipAddress=203.0.113.42

The IP address to filter events by (exact match)

billingProvider
string
Example: billingProvider=STRIPE

The billing provider on the instance's subscription. Empty when no subscription is linked.

externalPayerId
string
Example: externalPayerId=cus_NXyz12345abcdef

The raw external payer ID on the instance's subscription.

Responses

Response samples

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

operations-api

The set of APIs manage the operations and observe overall fleet health for service providers

DeploymentCellHealth operations-api

Authorizations:
api_key_header_Authorization
query Parameters
hostClusterID
string
Example: hostClusterID=hc-12345678

The host cluster ID to get the health for

serviceID
string
Example: serviceID=s-12345678

The service ID to get the health for

serviceEnvironmentID
string
Example: serviceEnvironmentID=se-12345678

The service environment ID to get the health for

Responses

Response samples

Content type
application/json
{
  • "cloudProvider": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "hostClusterID": "Itaque minima.",
  • "instanceHealth": {
    },
  • "regionCode": "us-west-1",
  • "serviceEnvironmentName": "prod",
  • "serviceName": "mysql"
}

ListEvents operations-api

Authorizations:
api_key_header_Authorization
query Parameters
nextPageToken
string
Example: nextPageToken=token

The next token to use for pagination

pageSize
integer <int64>
Example: pageSize=10

The number of resources to return per page

environmentType
string
Example: environmentType=PROD|PRIVATE|CANARY|STAGING|QA|DEV|GLOBAL

The type of service environment

eventTypes
Array of strings
Example: eventTypes=UnhealthyInstance|FailedDeployment|ScaleOut|UserSignUp|UserSubscription&eventTypes=UnhealthyInstance|FailedDeployment|ScaleOut|UserSignUp|UserSubscription

The event types to filter by

serviceID
string
Example: serviceID=s-123456

The service ID to list events for

serviceEnvironmentID
string
Example: serviceEnvironmentID=se-123456

The service environment ID to list events for

instanceID
string
Example: instanceID=instance-12345678

The instance ID to list events for

startDate
string <date-time>
Example: startDate=2023-01-01T10:00:00Z

Start date of the events

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

End date of the events

productTierID
string
Example: productTierID=Est corporis quia.

ID of a Product Tier

Responses

Response samples

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

ServiceHealth operations-api

Authorizations:
api_key_header_Authorization
query Parameters
serviceID
required
string
Example: serviceID=s-123456

The service ID to get the health for

serviceEnvironmentID
required
string
Example: serviceEnvironmentID=se-123456

The service environment ID to get the health for

Responses

Response samples

Content type
application/json
{
  • "cloudProviderHealthSummary": {
    },
  • "healthyInstances": 7392253028373106000,
  • "message": "Service is healthy",
  • "serviceEnvironmentID": "se-123456",
  • "serviceID": "s-123456",
  • "status": "Healthy",
  • "totalInstances": 3368247359776098000,
  • "unhealthyInstances": 4033218099113725000,
  • "unknownInstances": 5930305462440518000
}

report-api

The set of APIs provide aggregated reporting insights for service providers

DescribeEnvironmentReportStats report-api

Authorizations:
api_key_header_Authorization
path Parameters
environmentType
required
string
Example: PROD

The environment type to retrieve report statistics for

Responses

Response samples

Content type
application/json
{
  • "deployments": {
    },
  • "failovers": {
    },
  • "liveDeployments": {
    },
  • "subscriptions": {
    },
  • "upgrades": {
    },
  • "userSignups": {
    }
}

webhooks-api

ReceiveWebhook webhooks-api

path Parameters
id
required
string
Example: Numquam architecto natus aut a accusantium.

The unique id per producer.

Request Body schema: application/json
required

The event data

string

The event data

Responses

Request samples

Content type
application/json
"Ut consectetur."

notifications-api

ListNotificationChannels notifications-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

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

CreateNotificationChannel notifications-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
object (EmailConfiguration)
name
required
string

Name of the channel

object (PagerDutyConfiguration)
object (SlackConfiguration)
required
object (ChannelSubscription)
object (WebhookConfiguration)

Responses

Request samples

Content type
application/json
{
  • "email": {
    },
  • "name": "My Channel",
  • "pagerDuty": {
    },
  • "slack": {},
  • "subscription": {
    },
  • "webhook": {}
}

Response samples

Content type
application/json
"Quia eveniet sint voluptatem."

DeleteNotificationChannel notifications-api

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

Unique identifier of the channel

Responses

DescribeNotificationChannel notifications-api

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

Unique identifier of the channel

Responses

Response samples

Content type
application/json
{
  • "channelType": "EMAIL|SLACK|WEBHOOK|PAGERDUTY",
  • "email": {
    },
  • "id": "Amet et adipisci.",
  • "name": "My Channel",
  • "pagerDuty": {
    },
  • "slack": {},
  • "subscription": {
    },
  • "webhook": {}
}

UpdateNotificationChannel notifications-api

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

Unique identifier of the channel

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

Name of the channel

object (PagerDutyConfiguration)
object (SlackConfiguration)
object (ChannelSubscription)
object (WebhookConfiguration)

Responses

Request samples

Content type
application/json
{
  • "email": {
    },
  • "name": "My Channel",
  • "pagerDuty": {
    },
  • "slack": {},
  • "subscription": {
    },
  • "webhook": {}
}

NotificationChannelEventHistory notifications-api

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

Unique identifier of the channel

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

The start time of the range

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

The end time of the range

Responses

Response samples

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

GetEventCategoryTypeMap notifications-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

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

ReplayEvent notifications-api

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

Unique identifier of the event to replay

Responses

customer-onboardings-api

ListCustomerOnboardings customer-onboardings-api

Authorizations:
api_key_header_Authorization
query Parameters
pendingOnly
boolean
Example: pendingOnly=true

Whether to return only pending onboardings.

Responses

Response samples

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

CreateCustomerOnboarding customer-onboardings-api

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

DEPRECATED: Name will be generated automatically.

onboardingType
string

The type of onboarding to create.

Responses

Request samples

Content type
application/json
{
  • "name": "Alias et nihil accusamus odio.",
  • "onboardingType": "CONTAINER_IMAGE|DOCKER_COMPOSE|CLOUD_NATIVE"
}

Response samples

Content type
application/json
"Odio omnis nihil velit quam adipisci minima."

ListCustomerOnboardingStages customer-onboardings-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

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

DeleteCustomerOnboarding customer-onboardings-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: onboarding-1234567890

The ID of the onboarding.

Responses

DescribeCustomerOnboarding customer-onboardings-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: onboarding-1234567890

The ID of the onboarding.

Responses

Response samples

Content type
application/json
{
  • "base64GeneratedSpec": "Quasi reiciendis sint autem.",
  • "cloudNativeMetadata": {
    },
  • "containerImageMetadata": {
    },
  • "dockerComposeMetadata": {
    },
  • "id": "Debitis id sit ipsum et maiores.",
  • "isCompleted": true,
  • "name": "My Onboarding",
  • "onboardingType": "CONTAINER_IMAGE|DOCKER_COMPOSE|CLOUD_NATIVE",
  • "orgId": "Ut harum dignissimos.",
  • "serviceId": "service-1234567890",
  • "stages": [
    ],
  • "terraformExecutionPolicies": {
    },
  • "userId": "Vitae sint delectus ut."
}

UpdateCustomerOnboarding customer-onboardings-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: onboarding-1234567890

The ID of the onboarding.

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

Metadata for CLOUD_NATIVE onboarding type.

object (ContainerImageOnboardingMetadata)

Metadata for CONTAINER_IMAGE onboarding type.

object (DockerComposeOnboardingMetadata)

Metadata for DOCKER_COMPOSE onboarding type.

serviceId
string

The ID of the service associated with this onboarding.

object (OnboardingStage)

Responses

Request samples

Content type
application/json
{
  • "cloudNativeMetadata": {
    },
  • "containerImageMetadata": {
    },
  • "dockerComposeMetadata": {
    },
  • "serviceId": "service-1234567890",
  • "stage": {
    }
}

ScrutinizeOnboardingDeploymentArtifact customer-onboardings-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: onboarding-1234567890

The ID of the onboarding.

Responses

GenerateServicePlanSpecOrComposeSpecForOnboarding customer-onboardings-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: onboarding-1234567890

The ID of the onboarding.

Responses

Response samples

Content type
application/json
{
  • "specContent": "Eos placeat corporis earum ut enim."
}

helm-package-api

ListHelmPackageInstallations helm-package-api

Authorizations:
api_key_header_Authorization
query Parameters
hostClusterID
string
Example: hostClusterID=hc-12345678

The host cluster ID to list helm packages for

Responses

Response samples

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

fleet-custom-network-api

ListCustomNetworks fleet-custom-network-api

Authorizations:
api_key_header_Authorization
query Parameters
cloudProviderName
string
Example: cloudProviderName=aws

The name of the cloud provider to filter custom networks by

cloudProviderRegion
string
Example: cloudProviderRegion=us-east-1

The region of the cloud provider to filter custom networks by

customNetworksOnly
boolean
Example: customNetworksOnly=false

Flag indicating whether to return only custom networks, or to include default and imported networks as well

owningOrgID
string
Example: owningOrgID=org-12345678

The owning organization ID to filter custom networks by

Responses

Response samples

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

CreateCustomNetwork fleet-custom-network-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
cidr
required
string <cidr>
Default: "10.0.0.0/16"

CIDR block for the network

cloudProviderName
required
string

The name of the cloud provider that the instance is running on.

cloudProviderRegion
required
string

The region of the cloud provider that the instance is running in.

name
string

User friendly network name to help distinguish networks with same CIDRs

object (FleetNetworkFeaturesConfiguration)

Responses

Request samples

Content type
application/json
{
  • "cidr": "10.0.0.0/16",
  • "cloudProviderName": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "cloudProviderRegion": "us-east-1",
  • "name": "Prod us-east-1",
  • "networkFeaturesConfiguration": {
    }
}

Response samples

Content type
application/json
{
  • "cidr": "10.0.0.0/16",
  • "cloudProviderName": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "cloudProviderRegion": "us-east-1",
  • "created_at": "2023-01-10T00:00:00Z",
  • "id": "Veniam autem laborum ut velit.",
  • "last_modified_at": "2023-01-20T00:00:00Z",
  • "name": "Prod us-east-1",
  • "networkDefinitionType": "Default|Custom|Imported",
  • "networkFeaturesConfiguration": {
    },
  • "networkInstances": [
    ],
  • "owningOrgID": "org-12345678",
  • "owningOrgName": "my-customer",
  • "owningUserID": "user-12345678",
  • "owningUserName": "Jane Doe",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED"
}

DeleteCustomNetwork fleet-custom-network-api

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

ID of a custom network

Responses

DescribeCustomNetwork fleet-custom-network-api

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

ID of a custom network

Responses

Response samples

Content type
application/json
{
  • "cidr": "10.0.0.0/16",
  • "cloudProviderName": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "cloudProviderRegion": "us-east-1",
  • "created_at": "2023-01-10T00:00:00Z",
  • "id": "Alias dolorum ut non est et labore.",
  • "last_modified_at": "2023-01-20T00:00:00Z",
  • "name": "Prod us-east-1",
  • "networkDefinitionType": "Default|Custom|Imported",
  • "networkFeaturesConfiguration": {
    },
  • "networkInstances": [
    ],
  • "owningOrgID": "org-12345678",
  • "owningOrgName": "my-customer",
  • "owningUserID": "user-12345678",
  • "owningUserName": "Jane Doe",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED"
}

UpdateCustomNetwork fleet-custom-network-api

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

ID of a custom network

Request Body schema: application/json
required
name
string

User friendly network name to help distinguish networks with same CIDRs

Responses

Request samples

Content type
application/json
{
  • "name": "Dev us-east-1"
}

Response samples

Content type
application/json
{
  • "cidr": "10.0.0.0/16",
  • "cloudProviderName": "aws|azure|gcp|nebius|oci|byoc-onprem|all",
  • "cloudProviderRegion": "us-east-1",
  • "created_at": "2023-01-10T00:00:00Z",
  • "id": "Dolorem enim voluptas.",
  • "last_modified_at": "2023-01-20T00:00:00Z",
  • "name": "Prod us-east-1",
  • "networkDefinitionType": "Default|Custom|Imported",
  • "networkFeaturesConfiguration": {
    },
  • "networkInstances": [
    ],
  • "owningOrgID": "org-12345678",
  • "owningOrgName": "my-customer",
  • "owningUserID": "user-12345678",
  • "owningUserName": "Jane Doe",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|UPLOADING|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED"
}

usage-api

The usage APIs provide visibility into the customer usage.

GetConsolidatedUsage usage-api

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

The ID of the service to summarize usage for

environmentId
required
string
Example: env-12345678

The ID of the environment (e.g. PROD/DEV)

query Parameters
productTierId
string
Example: productTierId=pt-12345678

The product tier Id

startDate
string <date-time>
Example: startDate=2023-01-01T10:00:00Z

Start date of the usage report

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

End date of the usage report

Responses

Response samples

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

GetUsagePerDay usage-api

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

The ID of the subscription to get usage for

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

Start date of the usage report

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

End date of the usage report

Responses

Response samples

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

GetCurrentUsage usage-api

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

The ID of the subscription to get usage for

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

Start date of the usage report

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

End date of the usage report

Responses

Response samples

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

invoice-api

The set of APIs to manage invoices for service providers.

CreateInvoice invoice-api

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

Billing month to invoice in YYYY-MM format

customerId
required
string

Organization ID of the customer to invoice

Responses

Request samples

Content type
application/json
{
  • "billingPeriod": "2025-01",
  • "customerId": "Tempora vero dolorem perspiciatis."
}

Response samples

Content type
application/json
{
  • "billIssuedToUserEmail": "abcd@example.io",
  • "billIssuedToUserID": "user-1234568",
  • "billIssuedToUserName": "John Doe",
  • "billingPeriodEnd": "2023-09-30T23:59:59Z",
  • "billingPeriodStart": "2023-09-01T00:00:00Z",
  • "currency": "USD",
  • "customerId": "Iure quia consequuntur tenetur quae beatae aliquid.",
  • "customerName": "Acme Corp",
  • "dueDate": "2023-10-01T00:00:00Z",
  • "id": "invoice-1234568",
  • "invoiceDate": "2023-10-01T00:00:00Z",
  • "invoicePdf": "Commodi est nihil non quaerat laborum.",
  • "invoiceUrl": "https://dashboard.stripe.com/invoices/in_1R9aJ8G10a5MrQfCjUX3dstN",
  • "paymentTerms": "Net 30",
  • "status": "draft|open|paid|uncollectible|void",
  • "taxAmount": 10,
  • "totalAmount": 110,
  • "totalAmountWithoutTax": 100
}

DeleteInvoice invoice-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: invoice-1234568

ID of the invoice

Responses

ApproveInvoice invoice-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: invoice-1234568

ID of the invoice

Responses

ResendInvoice invoice-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: invoice-1234568

ID of the invoice

Responses

VoidInvoice invoice-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: invoice-1234568

ID of the invoice

Responses

ListInvoices invoice-api

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

Start date for filtering invoices

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

End date for filtering invoices

status
string
Example: status=open

Filter by invoice status

customerId
string
Example: customerId=customer-1234568

Filter by customer ID

billingProvider
string
Example: billingProvider=STRIPE

Filter by billing provider

Responses

Response samples

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

DescribeInvoice invoice-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: invoice-1234568

ID of the invoice

Responses

Response samples

Content type
application/json
{
  • "billIssuedToUserEmail": "abcd@example.io",
  • "billIssuedToUserID": "user-1234568",
  • "billIssuedToUserName": "John Doe",
  • "billingPeriodEnd": "2023-09-30T23:59:59Z",
  • "billingPeriodStart": "2023-09-01T00:00:00Z",
  • "currency": "USD",
  • "customerId": "Consectetur rerum.",
  • "customerName": "Acme Corp",
  • "dueDate": "2023-10-01T00:00:00Z",
  • "id": "invoice-1234568",
  • "invoiceDate": "2023-10-01T00:00:00Z",
  • "invoicePdf": "Quia repudiandae magni atque quia blanditiis dolorem.",
  • "invoiceUrl": "https://dashboard.stripe.com/invoices/in_1R9aJ8G10a5MrQfCjUX3dstN",
  • "paymentTerms": "Net 30",
  • "status": "draft|open|paid|uncollectible|void",
  • "taxAmount": 10,
  • "totalAmount": 110,
  • "totalAmountWithoutTax": 100
}

marketplace-api

The set of APIs that manage marketplace fulfillment.

ListMarketplaceChannels marketplace-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

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

ConnectMarketplaceChannel marketplace-api

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

Only for a channel whose billing credential differs from its contract-read credential. Omitted when sharesCredentials is true

channel
required
string
object

The channel's own credential fields. Write only: encrypted on arrival and never returned by any read

defaultProductTierId
string
defaultServiceEnvironmentId
string
defaultServiceId
string
object
enabled
boolean

Enabling is refused unless the config is complete: a callback URL, a mapped plan, and a plan that lists the marketplace billing provider. Refusing here rather than at the first purchase is the difference between a configuration error and a paying buyer nobody can serve

Array of objects (MarketplaceEventReceiver)

Where each event type is delivered, REPLACING the whole routing on every write. Omitting it leaves the stored routing alone; sending an empty array removes every receiver, which stops all deliveries and is the only way to do so

handoffTokenValiditySeconds
integer <int64> [ 3600 .. 2592000 ]

How long a handoff credential this channel mints stays redeemable. Omit it for the platform default of seven days.

Separate from isvConfirmTimeoutSeconds on purpose. That one is the SLA, and the default validity is deliberately longer than it, so an ISV who breaches the SLA can still recover on their own rather than needing an operator to reissue. One is how long we wait before raising an alarm; the other is how long the credential works.

Between 3600 (an hour) and 2592000 (thirty days). The floor is because the chain from checkout to your callback is several hops and a browser is free to be slow at any of them, so a shorter credential is one a buyer can be handed already dead. The ceiling is the window in which a cloud marketplace can void a purchase; a credential outliving that keeps working after the thing it selects has stopped being real

isvCallbackUrl
string

Where the buyer's browser lands. https only, no query and no fragment: Omnistrate appends its own parameter, and the code it appends is a bearer value that plaintext would expose in transit

isvConfirmTimeoutSeconds
integer <int64>
object
portBReceiverUrl
string

The receiver for every event, accepted for a client that predates per-event routing and applied to all of them. Prefer eventReceivers, which says the same thing explicitly and lets the events differ

portBSigningSecret
string >= 32 characters

The secret webhook deliveries to portBReceiverUrl are signed with, so your receiver can prove they came from us. Write only: encrypted on arrival and returned by no read, so keep a copy. At least 32 bytes, because deliveries are signed with HMAC-SHA256 and a key shorter than the hash weakens it.

REQUIRED THE FIRST TIME, and omitted afterwards to keep the stored one. Supplying a value IS a rotation, so sending one on every connect replaces the secret your receiver verifies with, every time. Connecting a channel that already exists is how an ISV edits it, which made that the common case rather than the rare one.

The rule is that every channel ends this call with a secret: one was supplied, or one is already stored. A connect with neither is refused, and the refusal says so

syntheticEmailDomain
string

Responses

Request samples

Content type
application/json
{
  • "autoConfirmIsv": true,
  • "billingCredentials": {
    },
  • "channel": "SUGER|SANDBOX",
  • "credentials": {
    },
  • "defaultProductTierId": "Ea fuga doloribus praesentium.",
  • "defaultServiceEnvironmentId": "Error occaecati.",
  • "defaultServiceId": "Itaque odio perspiciatis a ut libero sed.",
  • "dimensionMap": {
    },
  • "enabled": true,
  • "eventReceivers": [],
  • "handoffTokenValiditySeconds": 604800,
  • "isvCallbackUrl": "https://acme.example.com/omnistrate/return",
  • "isvConfirmTimeoutSeconds": 1222548053616294400,
  • "planMap": {
    },
  • "portBReceiverUrl": "https://hooks.acme.example.com/omnistrate",
  • "portBSigningSecret": "ctc",
  • "syntheticEmailDomain": "Voluptatem voluptas ullam est et rerum."
}

Response samples

Content type
application/json
{
  • "autoConfirmIsv": true,
  • "billingBinding": {
    },
  • "capabilities": {
    },
  • "channel": "SUGER|SANDBOX",
  • "contractCount": 7367092226299076000,
  • "createdAt": "2012-01-21T20:19:05Z",
  • "credentialsSet": false,
  • "defaultProductTierId": "Vel rerum tempora.",
  • "defaultServiceEnvironmentId": "Nihil eligendi repudiandae voluptatem vitae velit.",
  • "defaultServiceId": "Officia voluptas magnam eveniet sed.",
  • "dimensionMap": {
    },
  • "enabled": false,
  • "eventReceivers": [],
  • "handoffTokenValiditySeconds": 604800,
  • "id": "mkch-4t8w2qbnz1lp",
  • "isSimulated": false,
  • "isvCallbackUrl": "https://acme.example.com/omnistrate/return",
  • "isvConfirmTimeoutSeconds": 86400,
  • "landingUrl": "https://api.omnistrate.cloud/2022-09-01-00/fleet/marketplace/suger/landing",
  • "lastSyncedAt": "2000-07-29T23:54:55Z",
  • "planMap": {
    },
  • "portBReceiverUrl": "https://hooks.acme.example.com/omnistrate",
  • "portBSigningSecretId": "whsk-3f9a2c",
  • "portBSigningSecretSet": false,
  • "simulatedContractCount": 8105651126130525000,
  • "status": "NOT_CONNECTED|CONNECTED|DEGRADED|ERROR",
  • "statusMessage": "Et praesentium sequi sit ipsa harum aliquam.",
  • "syntheticEmailDomain": "mkt.acme.example.com",
  • "webhookUrl": "Quibusdam deleniti et."
}

DisconnectMarketplaceChannel marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
channel
required
string
Example: SUGER|SANDBOX

Which marketplace channel a contract came from. SUGER reaches AWS, Azure and GCP buyers through one listing. SANDBOX is the simulated channel, and is a real member of this set rather than a test mode

Responses

DescribeMarketplaceChannel marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
channel
required
string
Example: SUGER|SANDBOX

Which channel to describe

Responses

Response samples

Content type
application/json
{
  • "autoConfirmIsv": false,
  • "billingBinding": {
    },
  • "capabilities": {
    },
  • "channel": "SUGER|SANDBOX",
  • "contractCount": 6955988895808382000,
  • "createdAt": "2006-06-11T09:08:45Z",
  • "credentialsSet": true,
  • "defaultProductTierId": "Sint qui ut numquam doloremque hic.",
  • "defaultServiceEnvironmentId": "Ipsa amet.",
  • "defaultServiceId": "Eius facilis atque.",
  • "dimensionMap": {
    },
  • "enabled": true,
  • "eventReceivers": [],
  • "handoffTokenValiditySeconds": 604800,
  • "id": "mkch-4t8w2qbnz1lp",
  • "isSimulated": true,
  • "isvCallbackUrl": "https://acme.example.com/omnistrate/return",
  • "isvConfirmTimeoutSeconds": 86400,
  • "landingUrl": "https://api.omnistrate.cloud/2022-09-01-00/fleet/marketplace/suger/landing",
  • "lastSyncedAt": "1975-01-24T02:24:26Z",
  • "planMap": {
    },
  • "portBReceiverUrl": "https://hooks.acme.example.com/omnistrate",
  • "portBSigningSecretId": "whsk-3f9a2c",
  • "portBSigningSecretSet": false,
  • "simulatedContractCount": 1208699488960536300,
  • "status": "NOT_CONNECTED|CONNECTED|DEGRADED|ERROR",
  • "statusMessage": "Minima rerum ut amet quaerat consequatur.",
  • "syntheticEmailDomain": "mkt.acme.example.com",
  • "webhookUrl": "Aut ut quia quos."
}

UpdateMarketplaceChannel marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
channel
required
string
Example: SUGER|SANDBOX

Which marketplace channel a contract came from. SUGER reaches AWS, Azure and GCP buyers through one listing. SANDBOX is the simulated channel, and is a real member of this set rather than a test mode

Request Body schema: application/json
required
autoConfirmIsv
boolean
object
object

Replaces the stored credential when present. Omit it to leave the credential untouched, which is what makes it safe to change one unrelated field

defaultProductTierId
string
defaultServiceEnvironmentId
string
defaultServiceId
string
object
enabled
boolean
Array of objects (MarketplaceEventReceiver)

Replaces the stored routing when present. Omit it to leave the routing untouched, which is the same rule credentials follow above and for the same reason: an ISV changing one unrelated field must not silently stop their own deliveries

handoffTokenValiditySeconds
integer <int64> [ 3600 .. 2592000 ]

How long a handoff credential this channel mints stays redeemable. Omit it for the platform default of seven days.

Separate from isvConfirmTimeoutSeconds on purpose. That one is the SLA, and the default validity is deliberately longer than it, so an ISV who breaches the SLA can still recover on their own rather than needing an operator to reissue. One is how long we wait before raising an alarm; the other is how long the credential works.

Between 3600 (an hour) and 2592000 (thirty days). The floor is because the chain from checkout to your callback is several hops and a browser is free to be slow at any of them, so a shorter credential is one a buyer can be handed already dead. The ceiling is the window in which a cloud marketplace can void a purchase; a credential outliving that keeps working after the thing it selects has stopped being real

isvCallbackUrl
string
isvConfirmTimeoutSeconds
integer <int64>
object
portBReceiverUrl
string
portBSigningSecret
string >= 32 characters

Replaces the signing secret. Omit it to leave the current one alone, which is what makes it safe to change an unrelated field: supplying one here IS the rotation, and the outgoing secret stays valid for an overlap window so a receiver that has not installed the new one is not cut off the instant you rotate. At least 32 bytes. THERE IS NO WAY TO REMOVE ONE. Omitting it keeps the stored secret and an empty string is refused, because a channel without a signing secret delivers events no conforming receiver accepts, and the ability to reach that state is not worth having

syntheticEmailDomain
string

Responses

Request samples

Content type
application/json
{
  • "autoConfirmIsv": true,
  • "billingCredentials": {
    },
  • "credentials": {
    },
  • "defaultProductTierId": "Omnis praesentium vel quas hic veniam.",
  • "defaultServiceEnvironmentId": "Dolorem iure non et mollitia tempore aperiam.",
  • "defaultServiceId": "Magnam sunt magni quidem ipsum.",
  • "dimensionMap": {
    },
  • "enabled": false,
  • "eventReceivers": [],
  • "handoffTokenValiditySeconds": 604800,
  • "isvCallbackUrl": "Iure accusantium occaecati sit ut inventore.",
  • "isvConfirmTimeoutSeconds": 6310326890232024000,
  • "planMap": {
    },
  • "portBReceiverUrl": "Ullam tenetur et amet.",
  • "portBSigningSecret": "jhf",
  • "syntheticEmailDomain": "Et quo."
}

Response samples

Content type
application/json
{
  • "autoConfirmIsv": true,
  • "billingBinding": {
    },
  • "capabilities": {
    },
  • "channel": "SUGER|SANDBOX",
  • "contractCount": 1056513310457273100,
  • "createdAt": "1975-05-26T14:56:57Z",
  • "credentialsSet": true,
  • "defaultProductTierId": "Dolorum id amet doloremque accusantium.",
  • "defaultServiceEnvironmentId": "Quas optio odio excepturi modi ab occaecati.",
  • "defaultServiceId": "Rerum similique asperiores sunt officiis hic.",
  • "dimensionMap": {
    },
  • "enabled": false,
  • "eventReceivers": [],
  • "handoffTokenValiditySeconds": 604800,
  • "id": "mkch-4t8w2qbnz1lp",
  • "isSimulated": true,
  • "isvCallbackUrl": "https://acme.example.com/omnistrate/return",
  • "isvConfirmTimeoutSeconds": 86400,
  • "landingUrl": "https://api.omnistrate.cloud/2022-09-01-00/fleet/marketplace/suger/landing",
  • "lastSyncedAt": "2000-08-28T07:09:03Z",
  • "planMap": {
    },
  • "portBReceiverUrl": "https://hooks.acme.example.com/omnistrate",
  • "portBSigningSecretId": "whsk-3f9a2c",
  • "portBSigningSecretSet": true,
  • "simulatedContractCount": 4561176126260351500,
  • "status": "NOT_CONNECTED|CONNECTED|DEGRADED|ERROR",
  • "statusMessage": "Inventore recusandae.",
  • "syntheticEmailDomain": "mkt.acme.example.com",
  • "webhookUrl": "Reiciendis enim sit ut possimus omnis."
}

ListMarketplaceChannelListings marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
channel
required
string
Example: SUGER|SANDBOX

Which marketplace channel a contract came from. SUGER reaches AWS, Azure and GCP buyers through one listing. SANDBOX is the simulated channel, and is a real member of this set rather than a test mode

Responses

Response samples

Content type
application/json
{
  • "discoverySupported": true,
  • "listings": [
    ]
}

ValidateMarketplaceChannel marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
channel
required
string
Example: SUGER|SANDBOX

Which marketplace channel a contract came from. SUGER reaches AWS, Azure and GCP buyers through one listing. SANDBOX is the simulated channel, and is a real member of this set rather than a test mode

Responses

Response samples

Content type
application/json
{
  • "findings": [
    ],
  • "ok": true
}

ListMarketplaceContracts marketplace-api

Authorizations:
api_key_header_Authorization
query Parameters
channel
string
Example: channel=SUGER|SANDBOX

Filter to one channel

fulfillmentState
string
Example: fulfillmentState=DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED

Filter to one fulfillment state. This is how an operator lists the fulfillments that are stuck, rather than through a separate endpoint

quadrant
string
Example: quadrant=HEALTHY|ONBOARDING|PAYING_NOT_PROVISIONED|SERVING_NOT_BILLED|CLOSED

Filter to one reconciliation quadrant

needsAttention
boolean
Example: needsAttention=true

Only contracts past the handoff SLA while billable. The operator's working queue: every one of these is a customer paying for something they cannot use

includeSimulated
boolean
Example: includeSimulated=false

Sandbox contracts are excluded unless this is set, so a revenue view cannot pick them up by forgetting a filter

Responses

Response samples

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

DescribeMarketplaceContract marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: mkc-4t8w2qbnz1lp

The Omnistrate contract identifier

query Parameters
channel
string
Example: channel=SUGER|SANDBOX

With externalRef, resolves a contract from the marketplace identifier alone, which is what an ISV has to hand when the buyer contacts them

externalRef
string
Example: externalRef=Quisquam molestiae eum.

Responses

Response samples

Content type
application/json
{
  • "attentionSince": "1982-07-16T23:27:06Z",
  • "buyerName": "Acme",
  • "buyerRef": "buy_01J9Q7T4B2N0K5RCV8Y3M1Z6QA",
  • "channel": "SUGER|SANDBOX",
  • "commitAmount": "180000.00",
  • "contractStatus": "PENDING|ACTIVE|SUSPENDED|CANCELLED|EXPIRED",
  • "contractSyncedAt": "2005-11-29T10:28:14Z",
  • "contractVersion": 3,
  • "currency": "USD",
  • "endsAt": "1972-08-03T20:34:28Z",
  • "events": [
    ],
  • "externalRef": "ent_01J9Q7VZ3K8MTRQ2X4W6H0N5PD",
  • "fulfillmentState": "DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED",
  • "id": "mkc-4t8w2qbnz1lp",
  • "isSimulated": false,
  • "orgId": "org-7hq2md41xb",
  • "orgName": "Minus doloremque.",
  • "planRef": "plan_enterprise_annual_v3",
  • "quadrant": "HEALTHY|ONBOARDING|PAYING_NOT_PROVISIONED|SERVING_NOT_BILLED|CLOSED",
  • "quantity": 40,
  • "rawContract": {
    },
  • "rootUserEmail": "suger-buy_01J9Q7T4B2N0K5RCV8Y3M1Z6QA@mkt.acme.example.com",
  • "startsAt": "2015-06-11T21:36:13Z",
  • "subscriptionId": "sub-6pd3nz8kva"
}

DescribeMarketplaceFulfillment marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: mkc-4t8w2qbnz1lp

The Omnistrate contract identifier

Responses

Response samples

Content type
application/json
{
  • "blockedOn": "The ISV has not called approve. The last contract.discovered delivery was abandoned after 7 attempts over 24 hours",
  • "currentStage": "CONTRACT_RESOLVED|CUSTOMER_IDENTIFIED|CONTRACT_HELD|SUBSCRIPTION_REQUEST_CREATED|HANDED_OFF_TO_ISV|ISV_CONFIRMED|CONTRACT_COMMITTED|READY|CLOSED",
  • "fulfillmentState": "DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED",
  • "lastRetryAt": "2014-07-25T10:08:17Z",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "rehearsalHandoffToken": "hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD",
  • "rehearsalHandoffUrl": "https://portal.acme.example.com/marketplace/callback?code=hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD",
  • "retryCount": 1,
  • "runId": "Facilis aut sed ut.",
  • "stageTimeline": [
    ],
  • "stages": [
    ],
  • "subscriptionId": "sub-6pd3nz8kva",
  • "workflowId": "marketplace-fulfillment-mkc-4t8w2qbnz1lp-v1",
  • "workflowStatus": "RUNNING|COMPLETED|FAILED|TERMINATED|TIMED_OUT|NOT_STARTED"
}

ConfirmMarketplaceFulfillment marketplace-api

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

The Omnistrate contract identifier, as carried by marketplaceContractId on the contract.discovered event and returned by the handoff redeem

Request Body schema: application/json
required
externalReference
string

Your own identifier for the tenant you provisioned, recorded on the audit event. Optional, and worth sending: it is what lets a support conversation start from your id rather than ours

Responses

Request samples

Content type
application/json
{
  • "externalReference": "acme-tenant-4821"
}

Response samples

Content type
application/json
{
  • "blockedOn": "The ISV has not called approve. The last contract.discovered delivery was abandoned after 7 attempts over 24 hours",
  • "currentStage": "CONTRACT_RESOLVED|CUSTOMER_IDENTIFIED|CONTRACT_HELD|SUBSCRIPTION_REQUEST_CREATED|HANDED_OFF_TO_ISV|ISV_CONFIRMED|CONTRACT_COMMITTED|READY|CLOSED",
  • "fulfillmentState": "DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED",
  • "lastRetryAt": "1993-07-24T03:20:01Z",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "rehearsalHandoffToken": "hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD",
  • "rehearsalHandoffUrl": "https://portal.acme.example.com/marketplace/callback?code=hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD",
  • "retryCount": 1,
  • "runId": "Enim laborum et et corrupti.",
  • "stageTimeline": [
    ],
  • "stages": [
    ],
  • "subscriptionId": "sub-6pd3nz8kva",
  • "workflowId": "marketplace-fulfillment-mkc-4t8w2qbnz1lp-v1",
  • "workflowStatus": "RUNNING|COMPLETED|FAILED|TERMINATED|TIMED_OUT|NOT_STARTED"
}

DenyMarketplaceFulfillment marketplace-api

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

The Omnistrate contract identifier

Request Body schema: application/json
required
reason
string

Why the buyer was refused. Recorded on the audit event and shown to an operator, because a refused marketplace purchase is a conversation somebody will have to have

Responses

Request samples

Content type
application/json
{
  • "reason": "The buyer's domain is already served by an existing enterprise agreement"
}

Response samples

Content type
application/json
{
  • "blockedOn": "The ISV has not called approve. The last contract.discovered delivery was abandoned after 7 attempts over 24 hours",
  • "currentStage": "CONTRACT_RESOLVED|CUSTOMER_IDENTIFIED|CONTRACT_HELD|SUBSCRIPTION_REQUEST_CREATED|HANDED_OFF_TO_ISV|ISV_CONFIRMED|CONTRACT_COMMITTED|READY|CLOSED",
  • "fulfillmentState": "DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED",
  • "lastRetryAt": "1991-07-28T08:43:37Z",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "rehearsalHandoffToken": "hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD",
  • "rehearsalHandoffUrl": "https://portal.acme.example.com/marketplace/callback?code=hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD",
  • "retryCount": 1,
  • "runId": "Voluptatem voluptatum quidem aperiam.",
  • "stageTimeline": [
    ],
  • "stages": [
    ],
  • "subscriptionId": "sub-6pd3nz8kva",
  • "workflowId": "marketplace-fulfillment-mkc-4t8w2qbnz1lp-v1",
  • "workflowStatus": "RUNNING|COMPLETED|FAILED|TERMINATED|TIMED_OUT|NOT_STARTED"
}

RetryMarketplaceFulfillment marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
id
required
string
Example: mkc-4t8w2qbnz1lp

The Omnistrate contract identifier

Request Body schema: application/json
required
reason
string

Recorded on the audit event. Worth filling in, because a retry is a manual intervention on a contract that is usually already billing

stage
string

Which stage to re-enter. Defaults to the stage the workflow is stalled or failed on, which is what an operator wants in almost every case

Responses

Request samples

Content type
application/json
{
  • "reason": "ISV confirmed their receiver outage is resolved",
  • "stage": "CONTRACT_RESOLVED|CUSTOMER_IDENTIFIED|CONTRACT_HELD|SUBSCRIPTION_REQUEST_CREATED|HANDED_OFF_TO_ISV|ISV_CONFIRMED|CONTRACT_COMMITTED|READY|CLOSED"
}

Response samples

Content type
application/json
{
  • "blockedOn": "The ISV has not called approve. The last contract.discovered delivery was abandoned after 7 attempts over 24 hours",
  • "currentStage": "CONTRACT_RESOLVED|CUSTOMER_IDENTIFIED|CONTRACT_HELD|SUBSCRIPTION_REQUEST_CREATED|HANDED_OFF_TO_ISV|ISV_CONFIRMED|CONTRACT_COMMITTED|READY|CLOSED",
  • "fulfillmentState": "DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED",
  • "lastRetryAt": "2008-01-29T01:23:30Z",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "rehearsalHandoffToken": "hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD",
  • "rehearsalHandoffUrl": "https://portal.acme.example.com/marketplace/callback?code=hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD",
  • "retryCount": 1,
  • "runId": "Sed dolorum qui occaecati velit delectus deleniti.",
  • "stageTimeline": [
    ],
  • "stages": [
    ],
  • "subscriptionId": "sub-6pd3nz8kva",
  • "workflowId": "marketplace-fulfillment-mkc-4t8w2qbnz1lp-v1",
  • "workflowStatus": "RUNNING|COMPLETED|FAILED|TERMINATED|TIMED_OUT|NOT_STARTED"
}

ListMarketplaceDeliveries marketplace-api

Authorizations:
api_key_header_Authorization
query Parameters
channel
string
Example: channel=SUGER|SANDBOX

Filter to one channel

marketplaceContractId
string
Example: marketplaceContractId=Voluptatum nostrum id.

Filter to one contract, which is how a contract detail view scopes its own trail

direction
string
Example: direction=OUTBOUND|INBOUND|CHANNEL_INBOUND|CHANNEL_OUTBOUND

Who called whom. OUTBOUND is a webhook Omnistrate sent to the ISV's receiver and INBOUND is a call the ISV made to the marketplace API, both relative to the ISV. CHANNEL_INBOUND is the marketplace calling Omnistrate, and CHANNEL_OUTBOUND is Omnistrate calling the marketplace

status
string
Example: status=PENDING|DELIVERED|FAILED|BLOCKED

PENDING has not been answered yet. DELIVERED was accepted. FAILED exhausted its retries. BLOCKED was never sent, because the receiver address was refused

eventType
string
Example: eventType=contract.discovered|entitlement.updated|contract.suspended|contract.cancelled|fulfillment.failed

The type of a marketplace fulfillment event delivered to an ISV receiver

failuresOnly
boolean
Example: failuresOnly=false

A shortcut for the only filter combination anybody types twice

since
string <date-time>
Example: since=2013-06-12T19:42:07Z

Deliveries sent or received at or after this instant

Responses

Response samples

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

RedeliverMarketplaceDelivery marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
deliveryId
required
string
Example: Assumenda quae est qui.

Which delivery to send again. Must be an outbound one: there is nothing to redeliver about a call the ISV made. The redelivery carries the SAME eventId, so a receiver that already processed this event correctly treats it as a duplicate and does nothing

Request Body schema: application/json
required
reason
string

Why, recorded on the audit event. A redelivery is a manual intervention on a contract that is usually already billing

Responses

Request samples

Content type
application/json
{
  • "reason": "Fugit soluta quia."
}

Response samples

Content type
application/json
{
  • "attemptCount": 7921362674008052000,
  • "attempts": [
    ],
  • "callerCredentialId": "isvc_9Fq2Ld7Mv3",
  • "channel": "SUGER|SANDBOX",
  • "contractFulfillmentState": "DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED",
  • "contractRef": "ent_01J8ZQ4K7M2N",
  • "deliveryId": "mkd-03c1d9e558",
  • "destinationUrl": "Ea laboriosam laborum voluptatem iure dicta ipsum.",
  • "direction": "OUTBOUND|INBOUND|CHANNEL_INBOUND|CHANNEL_OUTBOUND",
  • "endpoint": "subscription.approve",
  • "eventId": "Perspiciatis sunt ea cupiditate.",
  • "eventType": "contract.discovered|entitlement.updated|contract.suspended|contract.cancelled|fulfillment.failed",
  • "isSimulated": false,
  • "marketplaceContractId": "Ut eius est est nisi.",
  • "maxAttempts": 7,
  • "method": "POST",
  • "nextAttemptAt": "2003-06-02T14:49:31Z",
  • "path": "/2022-09-01-00/fleet/marketplace/handoff/redeem",
  • "receivedAt": "1990-09-27T03:28:45Z",
  • "refusalReason": "EXPIRED_TOKEN|UNKNOWN_TOKEN|CROSS_ORG|ALREADY_APPROVED|INSUFFICIENT_PERMISSION|CONTRACT_NOT_FOUND",
  • "sentAt": "1998-11-22T14:24:55Z",
  • "stateChange": {
    },
  • "status": "PENDING|DELIVERED|FAILED|BLOCKED",
  • "subscriptionId": "Aperiam nesciunt amet.",
  • "terminalReason": "Ut delectus pariatur autem praesentium sit."
}

RedeemHandoff marketplace-api

Authorizations:
api_key_header_Authorization
Request Body schema: application/json
required
handoffToken
required
string^hoff_[0-9A-HJKMNP-TV-Z]{26}$

The value your buyer's arrival gave you: either the one appended to your callback URL when a buyer was redirected there, or the handoffToken from a contract.discovered webhook body. They are the same kind of value with the same seven day lifetime and the same non-consuming behaviour, so there is nothing to tell apart and one field takes either

Responses

Request samples

Content type
application/json
{
  • "handoffToken": "hoff_01J9XQ3M7ZK4V8N2PY6TBW5RCD"
}

Response samples

Content type
application/json
{
  • "buyerRef": "buy_01J9Q7T4B2N0K5RCV8Y3M1Z6QA",
  • "capabilities": {
    },
  • "channel": "SUGER|SANDBOX",
  • "contractStatus": "PENDING|ACTIVE|SUSPENDED|CANCELLED|EXPIRED",
  • "contractVersion": 3,
  • "externalRef": "suger_ent_01J9Q7T4B2N0K5RCV8Y3M1Z6QA",
  • "fulfillmentState": "DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED",
  • "handoffSlaExpiresAt": "2026-08-15T18:24:11Z",
  • "handoffTokenExpiresAt": "2026-08-21T18:24:11Z",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "org": {
    },
  • "plan": {
    },
  • "subscriptionId": "sub-6pd3nz8kva",
  • "subscriptionRequest": {
    }
}

MarketplaceLanding marketplace-api

path Parameters
channel
required
string
Example: SUGER|SANDBOX

Which channel the buyer arrived from. Selects the channel implementation that knows how to read this arrival's token back

serviceProviderOrgId
required
string
Example: org-8Hn2Kq4Vd1

Which ISV organization's listing was purchased. A SELECTOR for whose stored channel credentials perform the server-side readback, not a credential: it grants nothing, and substituting another organization's id resolves the token against an account where it does not exist

query Parameters
sugerEntitlementId
string
Example: sugerEntitlementId=ent_01J9Q7VZ3K8MTRQ2X4W6H0N5PD

Suger's entitlement identifier, appended by Suger's signup redirect. A pointer to be read back, never believed

partner
string
Example: partner=aws|azure|gcp

Which cloud the purchase originated on, as Suger reports it. Recorded for audit; the authoritative value comes from the readback

offerType
string
Example: offerType=Nihil debitis.

Suger's offer type for the purchase. Recorded for audit only

Responses

SandboxCheckout marketplace-api

Authorizations:
api_key_header_Authorization
path Parameters
externalRef
required
string
Example: sbx-ent-4f2a9c1b

The armed purchase's reference on the simulated channel, which is what the purchase control returned. Resolved against the CALLER'S sandbox: a reference belonging to another organization is simply not found

Responses

SendSandboxEvent marketplace-api

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

Which of the six event types to fire at the receiver

Responses

Request samples

Content type
application/json
{
  • "eventType": "contract.discovered|entitlement.updated|contract.suspended|contract.cancelled|fulfillment.failed"
}

Response samples

Content type
application/json
{
  • "checks": [
    ],
  • "deliveries": [
    ],
  • "finishedAt": "2007-01-05T03:52:21Z",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "receiverUrl": "https://hooks.acme.example.com/omnistrate",
  • "runId": "sbr-9zl3kq7wme",
  • "signingSecretId": "whsk-4t8w2qbnz1lp",
  • "startedAt": "1981-02-28T10:18:47Z",
  • "status": "PENDING|RUNNING|PASSED|FAILED"
}

DescribeSandboxRun marketplace-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "checks": [
    ],
  • "deliveries": [
    ],
  • "finishedAt": "1985-04-27T16:28:40Z",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "receiverUrl": "https://hooks.acme.example.com/omnistrate",
  • "runId": "sbr-9zl3kq7wme",
  • "signingSecretId": "whsk-4t8w2qbnz1lp",
  • "startedAt": "2001-04-09T02:20:42Z",
  • "status": "PENDING|RUNNING|PASSED|FAILED"
}

StartSandboxRun marketplace-api

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

Where to deliver. Validated on write: https only, no embedded credentials, and not a private, loopback, link-local or metadata address

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "checks": [
    ],
  • "deliveries": [
    ],
  • "finishedAt": "1985-04-16T15:22:00Z",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "receiverUrl": "https://hooks.acme.example.com/omnistrate",
  • "runId": "sbr-9zl3kq7wme",
  • "signingSecretId": "whsk-4t8w2qbnz1lp",
  • "startedAt": "1980-04-17T15:39:06Z",
  • "status": "PENDING|RUNNING|PASSED|FAILED"
}

RotateSandboxSecret marketplace-api

Authorizations:
api_key_header_Authorization

Responses

Response samples

Content type
application/json
{
  • "signingSecret": "whsec_2f8a1c6b9d3e4a70",
  • "signingSecretId": "whsk-4t8w2qbnz1lp"
}

SimulateContractEvent marketplace-api

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

The simulated buyer. Defaults to a value derived from the run, and supplying the same one twice is how an ISV rehearses a returning buyer accumulating a second contract against one organization

control
required
string
marketplaceContractId
string^(?P<entitytype>mkc)-(?P<entityid>[a-zA-Z0-9]...

Which simulated contract to act on. Omitted for purchase, which is the control that creates one. Required for every other control, because there is otherwise no way to say which of several rehearsals is meant

planRef
string

The plan to purchase or change to. Must be a key in the sandbox channel config's plan map, otherwise there is no product tier to fulfil against

quantity
integer <int64>

Seat or unit count, for purchase and quantity_change

Responses

Request samples

Content type
application/json
{
  • "buyerRef": "buy_01J9Q7T4B2N0K5RCV8Y3M1Z6QA",
  • "control": "purchase|plan_change|quantity_change|suspend|reinstate|pending_cancel|cancel|release_usage_gate|stall_handoff",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "planRef": "plan_enterprise_annual_v3",
  • "quantity": 40
}

Response samples

Content type
application/json
{
  • "contractStatus": "PENDING|ACTIVE|SUSPENDED|CANCELLED|EXPIRED",
  • "contractVersion": 3,
  • "control": "purchase|plan_change|quantity_change|suspend|reinstate|pending_cancel|cancel|release_usage_gate|stall_handoff",
  • "externalRef": "sbx-ent-4f2a9c1b",
  • "fulfillmentState": "DISCOVERED|IDENTIFIED|AWAITING_ISV|READY|SUSPENDED|DEPROVISIONING|CLOSED",
  • "handoffStalledUntil": "1999-06-05T01:21:52Z",
  • "marketplaceCheckoutUrl": "https://api.omnistrate.dev/2022-09-01-00/fleet/marketplace/sandbox/checkout/org-12aBcD/sbx-ent-4f2a9c1b",
  • "marketplaceContractId": "mkc-4t8w2qbnz1lp",
  • "meteringUnlockedAt": "1975-04-20T08:23:47Z",
  • "subscriptionRequestId": "subr-6pd3nz8kva"
}

ListSandboxUsageReports marketplace-api

Authorizations:
api_key_header_Authorization
query Parameters
marketplaceContractId
string
Example: marketplaceContractId=mkc-4t8w2qbnz1lp

Filter to one simulated sandbox contract

status
string
Example: status=PENDING|ACCEPTED|ACCEPTED_BY_DEDUPE|REJECTED_TERMINAL|UNMAPPED

What happened to one sandbox usage record on its way to the channel

windowStartFrom
string <date-time>
Example: windowStartFrom=1974-03-18T03:14:25Z

Only usage windows starting at or after this RFC3339 instant

windowStartTo
string <date-time>
Example: windowStartTo=2005-12-25T16:31:40Z

Only usage windows starting at or before this RFC3339 instant

Responses

Response samples

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

MarketplaceChannelWebhook marketplace-api

path Parameters
channel
required
string
Example: SUGER|SANDBOX

Which channel is delivering. In the path rather than the body, because the body is attacker controlled until the signature verifies and the route must be resolvable before then

serviceProviderOrgId
required
string
Example: org-4t8w2qbnz1lp

The ISV whose route this is. Also in the path, and compared against the organization the body claims: a delivery that is genuine for one ISV must not be accepted when replayed at another's route

header Parameters
X-Suger-Signature-256
string
Example: sha256=6f1a2c4b0e9d8a7f5c3b1e0d9a8f7e6d5c4b3a2918070605040302010fedcba9

The X-Suger-Signature-256 header: sha256= followed by the lowercase hex HMAC of the raw body

Responses

Response samples

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