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 manage the internal temporal workflows.

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

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": 2895141983678580700,
  • "CompletedWorkflowCount": 1398390855747510300,
  • "FailedWorkflowCount": 1501902494611022800,
  • "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": 9190528045361492000,
  • "UpdatedBy": "Anonymous",
  • "UpdatedReason": "Customer requested termination.",
  • "WorkflowType": "Service deployment.",
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|all",
  • "endTime": "2020-01-01T00:01:00Z",
  • "gcpProjectID": "my-project",
  • "id": "submit-create-instance-plan-instance-50h74sj46",
  • "manualOverride": {
    },
  • "orgName": "my-org",
  • "parentId": "Eos in aut deleniti odio repellendus deserunt.",
  • "planType": "my-plan",
  • "servicePlanName": "my-product-tier-plan",
  • "startTime": "2020-01-01T00:00:00Z",
  • "status": "IN_PROGRESS"
}

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": 9222438611062245000,
  • "UpdatedBy": "Anonymous",
  • "UpdatedReason": "Customer requested termination.",
  • "WorkflowType": "Service deployment.",
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|all",
  • "endTime": "2020-01-01T00:01:00Z",
  • "gcpProjectID": "my-project",
  • "id": "submit-create-instance-plan-instance-50h74sj46",
  • "manualOverride": {
    },
  • "orgName": "my-org",
  • "parentId": "Et veniam vero.",
  • "planType": "my-plan",
  • "servicePlanName": "my-product-tier-plan",
  • "startTime": "2020-01-01T00:00:00Z",
  • "status": "IN_PROGRESS"
}

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

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)\"",
  • "azureDisconnectShellCommand": "bash -c \"$(curl -fsSL https://omnistrate.com/account-setup/azure-disconnect.sh?account_config_id=ac-MOju2uwKM0)\"",
  • "azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
  • "azureTenantID": "12345678-1234-1234-1234-123456789012",
  • "byoaInstanceIDs": [
    ],
  • "cloudProviderId": "Vel velit qui odio et ut.",
  • "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)\"",
  • "gcpProjectID": "my-project",
  • "gcpProjectNumber": "123456789012",
  • "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
  • "id": "Quod et repudiandae laborum.",
  • "name": "Dev AWS account",
  • "status": "PENDING|VERIFYING|READY|FAILED|DELETING|READY_TO_OFFBOARD",
  • "statusMessage": "Account is ready"
}

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

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": "Ea accusamus voluptatibus."
}

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": "Consequatur vel sed ut est placeat consequatur."
}

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

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.

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

Responses

Request samples

Content type
application/json
{
  • "cloud_provider": "aws",
  • "custom_network_id": "n-1234567890",
  • "customTags": [
    ],
  • "externalPayerId": "external-billing-id-1234",
  • "network_type": "PUBLIC|INTERNAL",
  • "onprem_platform": "OpenShift",
  • "productTierVersion": "1.0",
  • "region": "us-east-1",
  • "requestParams": {
    },
  • "subscriptionId": "Sed enim aspernatur nostrum nihil itaque quo."
}

Response samples

Content type
application/json
{
  • "id": "Similique nihil sit minus."
}

SearchInventory inventory-api

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

The search query.

Responses

Request samples

Content type
application/json
{
  • "query": "foo"
}

Response samples

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

ListServiceOfferings inventory-api

Authorizations:
api_key_header_Authorization
query Parameters
orgId
string
Example: orgId=org-12345678

Org Id

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

set account config instance connection

Responses

Request samples

Content type
application/json
{
  • "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|all",
  • "createdAt": "2021-01-01T00:00:00Z",
  • "dashboardEndpoint": "https://dashboard.example.com",
  • "gcpProjectID": "my-project",
  • "id": "Expedita qui facilis alias fugiat temporibus.",
  • "region": "us-east-1",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|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.

Responses

Request samples

Content type
application/json
{
  • "resourceId": "Esse inventore."
}

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
{
  • "adopted": true,
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|all",
  • "consumptionResourceInstanceResult": {
    },
  • "defaultSubscription": true,
  • "deploymentCellID": "Eum incidunt vel dicta non.",
  • "environmentId": "se-123456",
  • "gcpProjectID": "my-project",
  • "input_params": {
    },
  • "instanceDebugCommands": [
    ],
  • "integrationsStatus": [],
  • "maintenanceTasks": {
    },
  • "managedResourceType": "PortsBasedProxy",
  • "manualOverride": {
    },
  • "organizationId": "Accusamus vitae expedita.",
  • "organizationName": "my-org",
  • "portsRegistrationStatus": {
    },
  • "productTierId": "Et quo.",
  • "productTierName": "premium",
  • "productTierType": "OMNISTRATE_DEDICATED",
  • "proxyType": "PortsBasedProxy",
  • "resourceVersionSummaries": [
    ],
  • "serviceEnvName": "dev",
  • "serviceId": "s-123456",
  • "serviceLogoURL": "Dolores ipsa.",
  • "serviceModelId": "Quae esse suscipit.",
  • "serviceModelName": "hosted",
  • "serviceModelType": "OMNISTRATE_HOSTED",
  • "serviceName": "mysql",
  • "subscriptionId": "Voluptatem quidem.",
  • "subscriptionOwnerName": "John Doe",
  • "subscriptionStatus": "ACTIVE|SUSPENDED|TERMINATED|CANCELLED",
  • "tierVersion": "1.0",
  • "tierVersionReleasedAt": "2020-01-01T00:00:00Z",
  • "tierVersionReleasedByUserId": "Aperiam recusandae consequatur facilis assumenda.",
  • "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": "Provident nam."
}

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": "Assumenda voluptas quo fugit rerum sint iusto."
}

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": "Distinctio et possimus magnam quidem."
}

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": "Officia facilis rerum voluptatem voluptatibus eos.",
  • "targetRegion": "us-west-2"
}

Response samples

Content type
application/json
{
  • "snapshotId": "Beatae tempore ea voluptas."
}

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": "Fugiat ullam expedita ut ullam.",
  • "instanceId": "instance-12345678",
  • "message": "instance-abcd1234 created",
  • "orgId": "Est enim et est sit.",
  • "orgName": "Acme Corporation",
  • "resourceName": "Galera",
  • "serviceId": "s-123456",
  • "time": "2023-01-10T00:00:00Z",
  • "userId": "Eligendi nostrum.",
  • "userName": "John Doe",
  • "workflowFailures": [
    ],
  • "workflowId": "Itaque omnis cumque beatae perspiciatis alias dolorem."
}

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

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": "Doloremque necessitatibus cumque et sint.",
  • "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.

Responses

Response samples

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

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": "Nobis ut beatae fuga omnis.",
  • "resourceOverrideConfiguration": {
    },
  • "targetTierVersion": "2.0"
}

Response samples

Content type
application/json
{
  • "adopted": true,
  • "awsAccountID": "123456789012",
  • "azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
  • "cloudProvider": "aws|azure|gcp|all",
  • "consumptionResourceInstanceResult": {
    },
  • "defaultSubscription": true,
  • "deploymentCellID": "Praesentium est asperiores non veritatis deserunt.",
  • "environmentId": "se-123456",
  • "gcpProjectID": "my-project",
  • "input_params": {
    },
  • "instanceDebugCommands": [
    ],
  • "integrationsStatus": [],
  • "maintenanceTasks": {
    },
  • "managedResourceType": "PortsBasedProxy",
  • "manualOverride": {
    },
  • "organizationId": "Repudiandae tenetur.",
  • "organizationName": "my-org",
  • "portsRegistrationStatus": {
    },
  • "productTierId": "Mollitia omnis.",
  • "productTierName": "premium",
  • "productTierType": "OMNISTRATE_DEDICATED",
  • "proxyType": "PortsBasedProxy",
  • "resourceVersionSummaries": [
    ],
  • "serviceEnvName": "dev",
  • "serviceId": "s-123456",
  • "serviceLogoURL": "Fugiat quas.",
  • "serviceModelId": "Dolor sapiente.",
  • "serviceModelName": "hosted",
  • "serviceModelType": "OMNISTRATE_HOSTED",
  • "serviceName": "mysql",
  • "subscriptionId": "Est consequatur.",
  • "subscriptionOwnerName": "John Doe",
  • "subscriptionStatus": "ACTIVE|SUSPENDED|TERMINATED|CANCELLED",
  • "tierVersion": "1.0",
  • "tierVersionReleasedAt": "2020-01-01T00:00:00Z",
  • "tierVersionReleasedByUserId": "Ex fuga exercitationem odit praesentium quos non.",
  • "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": "Atque eaque non eos natus laborum beatae."
}

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": "Eum illum veniam eaque."
}

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": "Id id dolor earum est.",
  • "productTierVersion": "1.0",
  • "serviceId": "s-123456",
  • "snapshotId": "Sapiente itaque omnis et aliquam.",
  • "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": "Quae ex quidem repellat."
}

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.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "se-123456",
  • "serviceId": "s-123456",
  • "snapshotId": "Enim nobis recusandae voluptas ullam."
}

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
{
  • "completeTime": "2021-09-01T00:00:00Z",
  • "createdTime": "2021-09-01T00:00:00Z",
  • "encrypted": true,
  • "environmentId": "se-123456",
  • "productTierId": "Ratione repellat.",
  • "productTierVersion": "1.0",
  • "progress": 99,
  • "region": "us-west-2",
  • "serviceId": "s-123456",
  • "snapshotId": "Sunt minima error accusantium ex atque.",
  • "snapshotType": "AutomatedSnapshot|ManualSnapshot",
  • "sourceInstanceId": "instance-12345678",
  • "status": "completed"
}

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": "Expedita numquam culpa accusamus et totam."
}

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": "Possimus in saepe iure voluptas itaque."
}

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=Assumenda voluptatum.

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

ProductTierId
string
Example: ProductTierId=Quisquam officiis occaecati rerum iusto atque itaque.

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

SubscriptionId
string
Example: SubscriptionId=Et iusto eos.

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

Whether to exclude detailed information about the resource instances.

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": "Temporibus sed odit aperiam aperiam quia.",
  • "serviceId": "s-123456",
  • "serviceModelType": "OMNISTRATE_HOSTED",
  • "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": "Ut nostrum assumenda eligendi similique aut dolores.",
  • "pageSize": 10,
  • "userId": "Nemo quaerat occaecati hic quisquam."
}

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": "Est sed nostrum nisi.",
  • "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"
}

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.

Responses

Request samples

Content type
application/json
{
  • "query": "foo"
}

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

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "Qui quos aut."
}

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

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": "Architecto dolores dolor alias.",
  • "priceEffectiveDate": "2019-01-01T00:00:00Z",
  • "productTierId": "Aut non est et ut sed."
}

Response samples

Content type
application/json
{
  • "id": "Suscipit at."
}

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": "Voluptatum est voluptatem.",
  • "instanceCount": 3,
  • "maxNumberOfInstances": 10,
  • "productTierId": "Perspiciatis rem.",
  • "productTierName": "Omnistrate Multi Tenancy",
  • "rootUserEmail": "abc@gmail.com",
  • "rootUserId": "Praesentium consectetur.",
  • "rootUserName": "John Doe",
  • "rootUserOrgId": "Quasi quaerat explicabo aut.",
  • "scheduledSubscriptionPricingList": [
    ],
  • "serviceId": "s-123456",
  • "serviceLogoURL": "Facere et dignissimos rerum est autem.",
  • "serviceName": "MySQL multi-writer service",
  • "status": "ACTIVE|SUSPENDED|TERMINATED|CANCELLED",
  • "subscriptionPricingAuditLogs": [
    ],
  • "updatedAt": "2019-01-01T00:00:00Z",
  • "updatedByUserId": "Voluptatem ut minima consequatur non cumque.",
  • "updatedByUserName": "John Doe",
  • "updatedByUserOrgId": "Et laborum voluptatem a accusantium.",
  • "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": "Molestias iusto et.",
  • "productTierId": "Rerum dolor cum ut.",
  • "productTierName": "Omnistrate Multi Tenancy",
  • "rootUserEmail": "abc@gmail.com",
  • "rootUserId": "Blanditiis dolores.",
  • "rootUserName": "John Doe",
  • "serviceId": "s-123456",
  • "serviceLogoURL": "Dignissimos aut.",
  • "serviceName": "MySQL multi-writer service",
  • "status": "PENDING|APPROVED|DENIED|CANCELLED",
  • "updatedAt": "2019-01-01T00:00:00Z",
  • "updatedByUserId": "In itaque.",
  • "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": "Natus doloremque repudiandae fuga.",
  • "lastModifiedByUserName": "Alice",
  • "orgId": "Eaque quos totam.",
  • "orgName": "Enterprise",
  • "orgUrl": "https://enterprise.com",
  • "status": "ACTIVE|NOT_ENABLED",
  • "subscriptions": [
    ],
  • "token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
  • "userId": "Nulla ut at sed aliquid sit.",
  • "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

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,
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Nihil quibusdam id.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Exercitationem et autem ullam.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "targetVersion": "2.0",
  • "targetVersionName": "Aut adipisci aut saepe eos nam doloremque.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Quia facere."
}

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,
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Cumque ipsa et consequuntur veniam sint.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Veritatis quis ipsa similique.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "targetVersion": "2.0",
  • "targetVersionName": "Non rerum distinctio ipsum at commodi ex.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Esse et consequatur."
}

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,
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Autem illo.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Et amet modi nihil vel.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "targetVersion": "2.0",
  • "targetVersionName": "Necessitatibus repellat ut dolor.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Et voluptas molestiae exercitationem vel deleniti."
}

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": "Accusamus sint repellendus sed eius.",
  • "serviceId": "s-123456",
  • "upgradePathId": "Numquam doloribus laboriosam temporibus."
}

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,
  • "inProgressCount": 7,
  • "lastModifiedBy": "John Doe",
  • "lastRequestedAction": "pause|cancel|resume|skip-instances|notify-customer",
  • "maxConcurrentUpgrades": 5,
  • "notifyCustomer": true,
  • "pendingCount": 3,
  • "plannedExecutionDate": "2020-01-01",
  • "productTierId": "Sint est dolores sapiente consequatur illo sequi.",
  • "releasedAt": "2020-01-01T00:00:00Z",
  • "scheduledCount": 10,
  • "serviceId": "s-123456",
  • "skippedCount": 0,
  • "sourceVersion": "1.0",
  • "sourceVersionName": "Fugiat quo expedita distinctio.",
  • "status": "IN_PROGRESS|COMPLETE|SCHEDULED|PENDING|FAILED|PAUSED|CANCELLED",
  • "targetVersion": "2.0",
  • "targetVersionName": "Vel nesciunt quaerat laborum et.",
  • "totalCount": 16,
  • "type": "Major|Incremental|UserDefined",
  • "updatedAt": "2020-01-01T00:00:00Z",
  • "upgradePathId": "Dolores ut praesentium corrupti est."
}

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": "Eos qui enim."
}

Response samples

Content type
application/json
{
  • "id": "Repellat iure alias aperiam aut."
}

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": "Voluptatum doloribus voluptas qui."
}

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
"Aut libero ad quasi in molestiae et."

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": "Autem repellendus.",
  • "lastModifiedByUserName": "Alice",
  • "orgId": "Et ab ut est.",
  • "orgName": "Enterprise",
  • "orgUrl": "https://enterprise.com",
  • "status": "ACTIVE|NOT_ENABLED",
  • "subscriptions": [
    ],
  • "token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
  • "userId": "Enim placeat temporibus rerum ipsam vero et.",
  • "userName": "Alice"
}

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

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
}

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": "Laboriosam at amet magni provident doloremque non.",
  • "accountID": "123456789012",
  • "amenities": [
    ],
  • "cloudProvider": "aws|azure|gcp|all",
  • "createdAt": "2021-01-01T00:00:00Z",
  • "currentNumberOfDeployments": 2,
  • "customNetworkDetail": {
    },
  • "customerEmail": "admin@example.com",
  • "customerOrganizationName": "My Customer Organization",
  • "description": "My Host Cluster",
  • "hasPendingChanges": true,
  • "healthStatus": {
    },
  • "helmPackages": [
    ],
  • "id": "Ad sed.",
  • "isCustomDeployment": true,
  • "isInSyncWithOrgTemplate": true,
  • "key": "my-host-cluster",
  • "kubernetesDashboardEndpoint": "https://my-k8s-dashboard.com",
  • "modelType": "OMNISTRATE_HOSTED|CUSTOMER_HOSTED|BYOA",
  • "pendingAmenities": [
    ],
  • "region": "us-east-1",
  • "regionId": "Laboriosam eos et iure.",
  • "role": "Dataplane|Provisioner",
  • "status": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|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
{
  • "customHelmExecutionLogsBase64": {
    }
}

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": "Nostrum quisquam.",
  • "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|all",
  • "customerEmail": "mycustomer@example.com",
  • "description": "My Adopted Host Cluster",
  • "id": "Est corrupti velit dolores est.",
  • "region": "us-east-1"
}

Response samples

Content type
application/json
{
  • "adoptionStatus": "FAILED|CANCELLED|PENDING_DEPENDENCY|PENDING|RUNNING|DEPLOYING|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": "55k"
}

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=Quis laborum provident nihil atque.&eventSourceTypes=Maxime consequatur voluptatum a nihil.

The event types to filter by

instanceID
string
Example: instanceID=instance-12345678

The instance ID to list events for

productTierID
string
Example: productTierID=Quisquam officiis occaecati rerum iusto atque itaque.

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

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|all",
  • "hostClusterID": "Ipsam laudantium reprehenderit soluta iure.",
  • "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=Quisquam officiis occaecati rerum iusto atque itaque.

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": 2901463188479049000,
  • "message": "Service is healthy",
  • "serviceEnvironmentID": "se-123456",
  • "serviceID": "s-123456",
  • "status": "Healthy",
  • "totalInstances": 8849014760593046000,
  • "unhealthyInstances": 1770533806155778800,
  • "unknownInstances": 7399828087882535000
}

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": {
    },
  • "subscriptions": {
    },
  • "upgrades": {
    },
  • "userSignups": {
    }
}

webhooks-api

ReceiveWebhook webhooks-api

path Parameters
id
required
string
Example: Molestias aspernatur odit quidem qui.

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
"Qui et omnis eaque pariatur."

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
"Optio quia pariatur a."

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": "Nihil est quia a.",
  • "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": [
    ]
}

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.

Responses

Request samples

Content type
application/json
{
  • "name": "Molestias aut voluptas quos voluptatum."
}

Response samples

Content type
application/json
"Laboriosam qui voluptatem."

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
{
  • "id": "Itaque autem sunt.",
  • "isCompleted": true,
  • "name": "My Onboarding",
  • "orgId": "Minima velit nesciunt eum.",
  • "serviceId": "service-1234567890",
  • "stages": [
    ],
  • "userId": "Illo fugit voluptatibus."
}

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

The ID of the service associated with this onboarding.

object (OnboardingStage)

Responses

Request samples

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

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|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|all",
  • "cloudProviderRegion": "us-east-1",
  • "id": "Non ut totam perspiciatis fugit et.",
  • "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|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|all",
  • "cloudProviderRegion": "us-east-1",
  • "id": "Corporis qui modi ut.",
  • "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|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|all",
  • "cloudProviderRegion": "us-east-1",
  • "id": "Non ut ut tenetur harum omnis autem.",
  • "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|READY|SUCCESS|COMPLETE|DELETING|DELETED|UNKNOWN|DISCONNECTED|DISCONNECTING|CONNECTING|DEACTIVATED"
}

usage-api

The usage APIs provide visibility into the customer usage.

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.

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