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

200

Content type

application/json

{"cloudProviderCosts": {"infra-abcdefgh": {"cloudProviderName": "aws",
"cost": [{"cost": 100,
"date": "2023-01-01T10:00:00Z"
},
{"cost": 200,
"date": "2023-01-02T10:00:00Z"
},
{"cost": 145,
"date": "2023-01-03T10:00:00Z"
}
],
"totalCost": 445
}
}
}

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

200

Content type

application/json

{"deploymentCellCosts": {"hc-abcdefgh": {"cloudProviderName": "aws",
"cost": [{"cost": 100,
"date": "2023-01-01T10:00:00Z"
},
{"cost": 200,
"date": "2023-01-02T10:00:00Z"
},
{"cost": 145,
"date": "2023-01-03T10:00:00Z"
}
],
"instancesCost": [{"cloudProviderName": "aws",
"instanceID": "instance-12345678",
"isDeleted": false,
"productTierID": "pt-12345678",
"productTierName": "Standard",
"productTierTenancyType": "OMNISTRATE_DEDICATED_TENANCY",
"regionName": "us-west-2",
"serviceEnvironmentID": "se-12345678",
"serviceID": "s-12345678",
"subscriptionID": "sub-12345678",
"totalCost": 100,
"utilization": 50
}
],
"regionName": "us-west-2",
"totalCost": 445
}
}
}

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

200

Content type

application/json

{"regionCosts": {"region-abcdefgh": {"cloudProviderName": "aws",
"cost": [{"cost": 100,
"date": "2023-01-01T10:00:00Z"
},
{"cost": 200,
"date": "2023-01-02T10:00:00Z"
},
{"cost": 145,
"date": "2023-01-03T10:00:00Z"
}
],
"regionName": "us-west-2",
"totalCost": 445
}
}
}

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

200

Content type

application/json

{"userCosts": {"user-abcdefgh": {"cost": [{"cost": 100,
"date": "2023-01-01T10:00:00Z"
},
{"cost": 200,
"date": "2023-01-02T10:00:00Z"
},
{"cost": 145,
"date": "2023-01-03T10:00:00Z"
}
],
"email": "admin@example.com",
"instancesCost": [{"cloudProviderName": "aws",
"instanceID": "instance-12345678",
"isDeleted": false,
"productTierID": "pt-12345678",
"productTierName": "Standard",
"productTierTenancyType": "OMNISTRATE_DEDICATED_TENANCY",
"regionName": "us-west-2",
"serviceEnvironmentID": "se-12345678",
"serviceID": "s-12345678",
"subscriptionID": "sub-12345678",
"totalCost": 100,
"utilization": 50
}
],
"orgID": "org-12345678",
"orgName": "Acme Corp",
"totalCost": 445,
"userName": "John Doe"
}
}
}

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

instanceId	string Example: instanceId=instance-12345678 The instance ID of the workflow
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

200

Content type

application/json

{"environmentId": "se-12345678",
"nextPageToken": "Dolorem rerum.",
"serviceId": "s-12345678",
"workflows": [{"ResourceCount": 6784647313322691000,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"orgName": "my-org",
"parentId": "Rerum aut tempore reprehenderit incidunt in aspernatur.",
"planType": "my-plan",
"servicePlanName": "my-product-tier-plan",
"startTime": "2020-01-01T00:00:00Z",
"status": "IN_PROGRESS"
},
{"ResourceCount": 6784647313322691000,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"orgName": "my-org",
"parentId": "Rerum aut tempore reprehenderit incidunt in aspernatur.",
"planType": "my-plan",
"servicePlanName": "my-product-tier-plan",
"startTime": "2020-01-01T00:00:00Z",
"status": "IN_PROGRESS"
},
{"ResourceCount": 6784647313322691000,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"orgName": "my-org",
"parentId": "Rerum aut tempore reprehenderit incidunt in aspernatur.",
"planType": "my-plan",
"servicePlanName": "my-product-tier-plan",
"startTime": "2020-01-01T00:00:00Z",
"status": "IN_PROGRESS"
}
]
}

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

200

Content type

application/json

{"ActiveWorkflowCount": 6872226942092117000,
"CompletedWorkflowCount": 7981946329601198000,
"FailedWorkflowCount": 1659428811784360000,
"environmentId": "se-12345678",
"serviceId": "s-12345678"
}

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

200

Content type

application/json

{"ResourceCount": 8141343506474429000,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"orgName": "my-org",
"parentId": "Architecto expedita maiores numquam blanditiis.",
"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

200

Content type

application/json

{"Resources": [{"actionHookDeploymentStatus": "IN_PROGRESS",
"computeDeploymentStatus": "IN_PROGRESS",
"configurationStatus": "IN_PROGRESS",
"infraDeploymentStatus": "IN_PROGRESS",
"monitoringStatus": "IN_PROGRESS",
"networkDeploymentStatus": "IN_PROGRESS",
"resourceName": "Galera",
"status": "IN_PROGRESS",
"storageDeploymentStatus": "IN_PROGRESS"
},
{"actionHookDeploymentStatus": "IN_PROGRESS",
"computeDeploymentStatus": "IN_PROGRESS",
"configurationStatus": "IN_PROGRESS",
"infraDeploymentStatus": "IN_PROGRESS",
"monitoringStatus": "IN_PROGRESS",
"networkDeploymentStatus": "IN_PROGRESS",
"resourceName": "Galera",
"status": "IN_PROGRESS",
"storageDeploymentStatus": "IN_PROGRESS"
},
{"actionHookDeploymentStatus": "IN_PROGRESS",
"computeDeploymentStatus": "IN_PROGRESS",
"configurationStatus": "IN_PROGRESS",
"infraDeploymentStatus": "IN_PROGRESS",
"monitoringStatus": "IN_PROGRESS",
"networkDeploymentStatus": "IN_PROGRESS",
"resourceName": "Galera",
"status": "IN_PROGRESS",
"storageDeploymentStatus": "IN_PROGRESS"
},
{"actionHookDeploymentStatus": "IN_PROGRESS",
"computeDeploymentStatus": "IN_PROGRESS",
"configurationStatus": "IN_PROGRESS",
"infraDeploymentStatus": "IN_PROGRESS",
"monitoringStatus": "IN_PROGRESS",
"networkDeploymentStatus": "IN_PROGRESS",
"resourceName": "Galera",
"status": "IN_PROGRESS",
"storageDeploymentStatus": "IN_PROGRESS"
}
],
"Workflow": {"ResourceCount": 6784647313322691000,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"orgName": "my-org",
"parentId": "Rerum aut tempore reprehenderit incidunt in aspernatur.",
"planType": "my-plan",
"servicePlanName": "my-product-tier-plan",
"startTime": "2020-01-01T00:00:00Z",
"status": "IN_PROGRESS"
},
"environmentId": "se-12345678",
"serviceId": "s-12345678"
}

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

The status of the workflow execution.

Responses

Request samples

Payload

Content type

application/json

{"status": "Pause"
}

Response samples

200

Content type

application/json

{"ResourceCount": 551798076900687800,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"orgName": "my-org",
"parentId": "Hic tenetur natus et eos.",
"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

200

Content type

application/json

{"environmentId": "se-12345678",
"id": "submit-create-instance-plan-instance-50h74sj46",
"resources": [{"resourceId": "r-12345678",
"resourceKey": "db",
"resourceName": "Galera",
"workflowSteps": [{"events": [{"eventTime": "2020-01-01T00:00:00Z",
"eventType": "WorkflowStepStarted",
"message": "Bootstrap started"
},
{"eventTime": "2020-01-01T00:01:00Z",
"eventType": "WorkflowStepCompleted",
"message": "Bootstrap completed"
}
],
"stepName": "Bootstrap"
},
{"events": [{"eventTime": "2020-01-01T00:02:00Z",
"eventType": "WorkflowStepStarted",
"message": "Compute deployment started"
},
{"eventTime": "2020-01-01T00:03:00Z",
"eventType": "WorkflowStepCompleted",
"message": "Compute deployment completed"
}
],
"stepName": "Compute"
},
{"events": [{"eventTime": "2020-01-01T00:04:00Z",
"eventType": "WorkflowStepStarted",
"message": "Network deployment started"
},
{"eventTime": "2020-01-01T00:05:00Z",
"eventType": "WorkflowStepFailed",
"message": "Details of the failure"
}
],
"stepName": "Network"
}
]
}
],
"serviceId": "s-12345678"
}

inventory-api

The set of APIs manage the inventory for service providers.

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

200

Content type

application/json

{"nextPageToken": "next-token",
"organizations": [{"email": "omnistrate-devops@examplecorp.com",
"orgId": "o-12345678",
"orgName": "Acme Corp",
"orgUrl": "omnistrate.com"
},
{"email": "omnistrate-devops@examplecorp.com",
"orgId": "o-12345678",
"orgName": "Acme Corp",
"orgUrl": "omnistrate.com"
},
{"email": "omnistrate-devops@examplecorp.com",
"orgId": "o-12345678",
"orgName": "Acme Corp",
"orgUrl": "omnistrate.com"
}
]
}

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

Payload

Content type

application/json

{"cloud_provider": "aws",
"region": "us-east-1",
"requestParams": {"param1": "value1",
"param2": "value2"
}
}

Response samples

202

Content type

application/json

{"id": "Voluptatem voluptatem nulla aspernatur qui."
}

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
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
productTierVersion	string The product tier version
region	string The region code
requestParams	any The request parameters
subscriptionId	string The subscription ID

Responses

Request samples

Payload

Content type

application/json

{"cloud_provider": "aws",
"custom_network_id": "n-1234567890",
"externalPayerId": "external-billing-id-1234",
"network_type": "PUBLIC|INTERNAL",
"productTierVersion": "1.0",
"region": "us-east-1",
"requestParams": {"param1": "value1",
"param2": "value2"
},
"subscriptionId": "sub-12345678"
}

Response samples

202

Content type

application/json

{"id": "Ut minus non minus occaecati."
}

SearchInventory inventory-api

Authorizations:

api_key_header_Authorization

Request Body schema: application/json
required

query

required

string

The search query.

Responses

Request samples

Payload

Content type

application/json

{"query": "foo"
}

Response samples

200

Content type

application/json

{"deploymentCellResults": [{"cloudProvider": "aws",
"description": "The Deployment Cell is hosted in us-east-2 on aws.",
"id": "hc-12345",
"regionCode": "us-east-2",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceName": "MyService"
}
],
"notificationResults": [{"description": "Deployment completed",
"id": "event-12345",
"name": "Deployment",
"priority": "Low",
"resourceName": "postgres",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceName": "MyService",
"time": "2020-01-01T00:01:00Z",
"type": "SuccessfulDeployment"
}
],
"proxyInstanceResults": [{"cloudProvider": "aws",
"description": "My proxy.",
"id": "i-12345",
"managed": true,
"managedResourceType": "PortsBasedProxy",
"portsRegistrationStatus": {"instance-123": [30000,
30001
],
"instance-456": [30002,
30003
]
},
"proxyType": "PortsBasedProxy",
"regionCode": "us-west-1",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceName": "MyService",
"status": "Running",
"statusDescription": "Instance is running.",
"targetResourceName": "postgres"
}
],
"resourceInstanceResults": [{"cloudProvider": "aws",
"description": "My proxy.",
"id": "i-12345",
"managed": true,
"managedResourceType": "PortsBasedProxy",
"portsRegistrationStatus": {"instance-123": [30000,
30001
],
"instance-456": [30002,
30003
]
},
"productTierId": "pt-12345",
"productTierName": "free",
"productTierVersion": "2.0",
"proxyType": "PortsBasedProxy",
"regionCode": "us-west-1",
"resourceName": "postgres",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceName": "MyService",
"status": "Running",
"statusDescription": "Instance is running.",
"subscriptionID": "sub-12345"
}
],
"resourceResults": [{"description": "The Resource is hosted in us-east-2 on aws.",
"id": "i-12345",
"name": "postgres",
"productTierId": "pt-12345",
"productTierName": "prod",
"serviceApiId": "sa-12345",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceModelId": "sm-12345",
"serviceName": "MyService"
}
],
"serverlessProxyResults": [{"description": "My serverless proxy.",
"id": "r-12345",
"managed": false,
"managedResourceType": "PortsBasedProxy",
"name": "proxy",
"productTierId": "pt-12345",
"productTierName": "prod",
"proxyType": "PortsBasedProxy",
"serviceApiId": "sa-12345",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceModelId": "sm-12345",
"serviceName": "MyService"
}
],
"servicePlanResults": [{"deploymentType": "CUSTOMER_HOSTED",
"description": "The postgres service plan.",
"id": "pt-12345",
"name": "postgres",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceName": "MyService",
"tenancyType": "OMNISTRATE_DEDICATED_TENANCY",
"version": "2.0",
"versionSetStatus": "Active"
}
],
"serviceResults": [{"description": "My Postgres Service",
"id": "s-12345678",
"name": "MyService"
}
],
"subscriptionResults": [{"id": "sub-12345",
"orgID": "org-12345",
"productTierID": "pt-12345",
"rootUserEmail": "bob@enterprise.com",
"rootUserID": "user-12345",
"rootUserName": "bob",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceName": "MyService",
"servicePlanName": "prod",
"status": "ACTIVE"
}
],
"upgradePathResults": [{"id": "upgrade-12345",
"productTierID": "pt-12345",
"productTierName": "prod",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceName": "MyService",
"status": "IN_PROGRESS"
}
],
"userResults": [{"email": "bob@omnistrate.com",
"external": false,
"id": "user-12345",
"name": "Bob",
"orgName": "Bob's Organization"
}
],
"workflowResults": [{"id": "submit-update-instance-abcdefgh",
"resourceName": "postgres",
"serviceEnvironmentID": "se-12345",
"serviceEnvironmentName": "MyEnvironment",
"serviceEnvironmentType": "PROD",
"serviceID": "s-12345",
"serviceName": "MyService",
"status": "IN_PROGRESS",
"type": "Service deployment"
}
]
}

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

200

Content type

application/json

{"ConsumptionListServiceOfferingsResult": {"nextPageToken": "next-token",
"serviceIds": ["s-12345678",
"s-abcdefgh"
],
"services": [{"createdAt": "2019-01-01T00:00:00Z",
"isDeprecated": false,
"offerings": [{"allowCreatesWhenPaymentNotConfigured": true,
"assets": {"cloudFormationURL": "https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://s3.amazonaws.com/omnistrate-cloudformation-dev/org-EUVvex3bVm/account-config-setup-template.yaml&stackName=AccountConfigSetup&param_AccountConfigIdentityId=org-EUVvex3bVm&param_OIDCIssuerURLWithoutPrefix=oidc.eks.us-east-2.amazonaws.com/id/C339DC3726AD36506FB7ABE55754784F&param_OIDCIssuerThumbprintList=9e99a48a9960b14926bb7f3b02e22da2b0ab7280&param_ServiceAccount=bootstrap-sa",
"cloudFormationURLNoLB": "https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://s3.amazonaws.com/omnistrate-cloudformation-dev/org-EUVvex3bVm/account-config-setup-template.yaml&stackName=AccountConfigSetup&param_AccountConfigIdentityId=org-EUVvex3bVm&param_OIDCIssuerURLWithoutPrefix=oidc.eks.us-east-2.amazonaws.com/id/C339DC3726AD36506FB7ABE55754784F&param_OIDCIssuerThumbprintList=9e99a48a9960b14926bb7f3b02e22da2b0ab7280&param_ServiceAccount=bootstrap-sa&param_CreateLoadBalancerPolicy=false"
},
"maxNumberOfInstances": 4,
"productTierName": "Premium",
"productTierURLKey": "premium",
"resourceParameters": [{"name": "MySQL",
"urlKey": "mysql"
},
{"name": "Redis",
"urlKey": "redis"
}
],
"serviceAPIID": "sa-12345678",
"serviceAPIVersion": "v1",
"serviceEnvironmentName": "Production",
"serviceEnvironmentURLKey": "prod",
"serviceEnvironmentVisibility": "PRIVATE",
"serviceModelName": "Bring Your Own Account",
"serviceModelURLKey": "byoa"
},
{"productTierName": "Basic",
"productTierURLKey": "basic",
"resourceParameters": [{"name": "MySQL",
"urlKey": "mysql"
},
{"name": "Redis",
"urlKey": "redis"
}
],
"serviceAPIID": "sa-abcdefgh",
"serviceAPIVersion": "v1",
"serviceEnvironmentName": "Production",
"serviceEnvironmentURLKey": "prod",
"serviceEnvironmentVisibility": "PUBLIC",
"serviceModelName": "Hosted",
"serviceModelURLKey": "hosted"
}
],
"serviceDescription": "MySQL is a relational database",
"serviceId": "s-12345678",
"serviceName": "MySQL",
"serviceOrgId": "org-12345678",
"serviceProviderId": "sp-9zrg9W8Are",
"serviceProviderName": "Omnistrate, Inc.",
"serviceURLKey": "mysql"
},
{"createdAt": "2019-01-01T00:00:00Z",
"isDeprecated": false,
"offerings": [{"allowCreatesWhenPaymentNotConfigured": true,
"assets": {"cloudFormationURL": "https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://s3.amazonaws.com/omnistrate-cloudformation-dev/org-EUVvex3bVm/account-config-setup-template.yaml&stackName=AccountConfigSetup&param_AccountConfigIdentityId=org-EUVvex3bVm&param_OIDCIssuerURLWithoutPrefix=oidc.eks.us-east-2.amazonaws.com/id/C339DC3726AD36506FB7ABE55754784F&param_OIDCIssuerThumbprintList=9e99a48a9960b14926bb7f3b02e22da2b0ab7280&param_ServiceAccount=bootstrap-sa",
"cloudFormationURLNoLB": "https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://s3.amazonaws.com/omnistrate-cloudformation-dev/org-EUVvex3bVm/account-config-setup-template.yaml&stackName=AccountConfigSetup&param_AccountConfigIdentityId=org-EUVvex3bVm&param_OIDCIssuerURLWithoutPrefix=oidc.eks.us-east-2.amazonaws.com/id/C339DC3726AD36506FB7ABE55754784F&param_OIDCIssuerThumbprintList=9e99a48a9960b14926bb7f3b02e22da2b0ab7280&param_ServiceAccount=bootstrap-sa&param_CreateLoadBalancerPolicy=false"
},
"maxNumberOfInstances": 4,
"productTierName": "Premium",
"productTierURLKey": "premium",
"resourceParameters": [{"name": "MySQL",
"urlKey": "mysql"
},
{"name": "Redis",
"urlKey": "redis"
}
],
"serviceAPIID": "sa-12345678",
"serviceAPIVersion": "v1",
"serviceEnvironmentName": "Production",
"serviceEnvironmentURLKey": "prod",
"serviceEnvironmentVisibility": "PRIVATE",
"serviceModelName": "Bring Your Own Account",
"serviceModelURLKey": "byoa"
},
{"productTierName": "Basic",
"productTierURLKey": "basic",
"resourceParameters": [{"name": "MySQL",
"urlKey": "mysql"
},
{"name": "Redis",
"urlKey": "redis"
}
],
"serviceAPIID": "sa-abcdefgh",
"serviceAPIVersion": "v1",
"serviceEnvironmentName": "Production",
"serviceEnvironmentURLKey": "prod",
"serviceEnvironmentVisibility": "PUBLIC",
"serviceModelName": "Hosted",
"serviceModelURLKey": "hosted"
}
],
"serviceDescription": "MySQL is a relational database",
"serviceId": "s-12345678",
"serviceName": "MySQL",
"serviceOrgId": "org-12345678",
"serviceProviderId": "sp-9zrg9W8Are",
"serviceProviderName": "Omnistrate, Inc.",
"serviceURLKey": "mysql"
},
{"createdAt": "2019-01-01T00:00:00Z",
"isDeprecated": false,
"offerings": [{"allowCreatesWhenPaymentNotConfigured": true,
"assets": {"cloudFormationURL": "https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://s3.amazonaws.com/omnistrate-cloudformation-dev/org-EUVvex3bVm/account-config-setup-template.yaml&stackName=AccountConfigSetup&param_AccountConfigIdentityId=org-EUVvex3bVm&param_OIDCIssuerURLWithoutPrefix=oidc.eks.us-east-2.amazonaws.com/id/C339DC3726AD36506FB7ABE55754784F&param_OIDCIssuerThumbprintList=9e99a48a9960b14926bb7f3b02e22da2b0ab7280&param_ServiceAccount=bootstrap-sa",
"cloudFormationURLNoLB": "https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://s3.amazonaws.com/omnistrate-cloudformation-dev/org-EUVvex3bVm/account-config-setup-template.yaml&stackName=AccountConfigSetup&param_AccountConfigIdentityId=org-EUVvex3bVm&param_OIDCIssuerURLWithoutPrefix=oidc.eks.us-east-2.amazonaws.com/id/C339DC3726AD36506FB7ABE55754784F&param_OIDCIssuerThumbprintList=9e99a48a9960b14926bb7f3b02e22da2b0ab7280&param_ServiceAccount=bootstrap-sa&param_CreateLoadBalancerPolicy=false"
},
"maxNumberOfInstances": 4,
"productTierName": "Premium",
"productTierURLKey": "premium",
"resourceParameters": [{"name": "MySQL",
"urlKey": "mysql"
},
{"name": "Redis",
"urlKey": "redis"
}
],
"serviceAPIID": "sa-12345678",
"serviceAPIVersion": "v1",
"serviceEnvironmentName": "Production",
"serviceEnvironmentURLKey": "prod",
"serviceEnvironmentVisibility": "PRIVATE",
"serviceModelName": "Bring Your Own Account",
"serviceModelURLKey": "byoa"
},
{"productTierName": "Basic",
"productTierURLKey": "basic",
"resourceParameters": [{"name": "MySQL",
"urlKey": "mysql"
},
{"name": "Redis",
"urlKey": "redis"
}
],
"serviceAPIID": "sa-abcdefgh",
"serviceAPIVersion": "v1",
"serviceEnvironmentName": "Production",
"serviceEnvironmentURLKey": "prod",
"serviceEnvironmentVisibility": "PUBLIC",
"serviceModelName": "Hosted",
"serviceModelURLKey": "hosted"
}
],
"serviceDescription": "MySQL is a relational database",
"serviceId": "s-12345678",
"serviceName": "MySQL",
"serviceOrgId": "org-12345678",
"serviceProviderId": "sp-9zrg9W8Are",
"serviceProviderName": "Omnistrate, Inc.",
"serviceURLKey": "mysql"
}
]
}
}

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

200

Content type

application/json

{"ConsumptionDescribeServiceOfferingResult": {"createdAt": "2019-01-01T00:00:00Z",
"isDeprecated": false,
"offerings": [{"allowCreatesWhenPaymentNotConfigured": true,
"assets": {"cloudFormationURL": "https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://s3.amazonaws.com/omnistrate-cloudformation-dev/org-EUVvex3bVm/account-config-setup-template.yaml&stackName=AccountConfigSetup&param_AccountConfigIdentityId=org-EUVvex3bVm&param_OIDCIssuerURLWithoutPrefix=oidc.eks.us-east-2.amazonaws.com/id/C339DC3726AD36506FB7ABE55754784F&param_OIDCIssuerThumbprintList=9e99a48a9960b14926bb7f3b02e22da2b0ab7280&param_ServiceAccount=bootstrap-sa",
"cloudFormationURLNoLB": "https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://s3.amazonaws.com/omnistrate-cloudformation-dev/org-EUVvex3bVm/account-config-setup-template.yaml&stackName=AccountConfigSetup&param_AccountConfigIdentityId=org-EUVvex3bVm&param_OIDCIssuerURLWithoutPrefix=oidc.eks.us-east-2.amazonaws.com/id/C339DC3726AD36506FB7ABE55754784F&param_OIDCIssuerThumbprintList=9e99a48a9960b14926bb7f3b02e22da2b0ab7280&param_ServiceAccount=bootstrap-sa&param_CreateLoadBalancerPolicy=false"
},
"maxNumberOfInstances": 4,
"productTierName": "Premium",
"productTierURLKey": "premium",
"resourceParameters": [{"name": "MySQL",
"urlKey": "mysql"
},
{"name": "Redis",
"urlKey": "redis"
}
],
"serviceAPIID": "sa-12345678",
"serviceAPIVersion": "v1",
"serviceEnvironmentName": "Production",
"serviceEnvironmentURLKey": "prod",
"serviceEnvironmentVisibility": "PRIVATE",
"serviceModelName": "Bring Your Own Account",
"serviceModelURLKey": "byoa"
},
{"productTierName": "Basic",
"productTierURLKey": "basic",
"resourceParameters": [{"name": "MySQL",
"urlKey": "mysql"
},
{"name": "Redis",
"urlKey": "redis"
}
],
"serviceAPIID": "sa-abcdefgh",
"serviceAPIVersion": "v1",
"serviceEnvironmentName": "Production",
"serviceEnvironmentURLKey": "prod",
"serviceEnvironmentVisibility": "PUBLIC",
"serviceModelName": "Hosted",
"serviceModelURLKey": "hosted"
}
],
"serviceDescription": "MySQL is a relational database",
"serviceId": "s-12345678",
"serviceName": "MySQL",
"serviceOrgId": "org-12345678",
"serviceProviderId": "sp-9zrg9W8Are",
"serviceProviderName": "Omnistrate, Inc.",
"serviceURLKey": "mysql"
}
}

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

200

Content type

application/json

{"ConsumptionDescribeServiceOfferingResourceResult": {"apis": [{"inputParameters": [{"defaultValue": null,
"description": "The name of the server",
"displayName": "Server Name",
"isList": false,
"key": "serverName",
"modifiable": true,
"options": null,
"required": true,
"type": "string"
},
{"defaultValue": "option1",
"description": "The type of the server",
"displayName": "Server Type",
"isList": false,
"key": "serverType",
"modifiable": true,
"options": ["option1",
"option2"
],
"required": true,
"type": "string"
}
],
"outputParameters": [{"description": "The name of the server",
"displayName": "Server Name",
"isList": false,
"key": "serverName",
"type": "string"
},
{"description": "The type of the server",
"displayName": "Server Type",
"isList": false,
"key": "serverType",
"type": "string"
}
],
"verb": "create"
},
{"inputParameters": [{"defaultValue": null,
"description": "The name of the server",
"displayName": "Server Name",
"isList": false,
"key": "serverName",
"modifiable": true,
"options": null,
"required": true,
"type": "string"
}
],
"outputParameters": [{"description": "The name of the server",
"displayName": "Server Name",
"isList": false,
"key": "serverName",
"type": "string"
},
{"description": "The type of the server",
"displayName": "Server Type",
"isList": false,
"key": "serverType",
"type": "string"
}
],
"verb": "describe"
}
]
}
}

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

Payload

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

Payload

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

200

Content type

application/json

{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"dashboardEndpoint": "https://dashboard.example.com",
"gcpProjectID": "my-project",
"id": "hc-12345678",
"instanceID": "instance-12345678",
"region": "us-east-1",
"status": "READY",
"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

200

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.

Responses

Response samples

200

Content type

application/json

{"hostClusters": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"dashboardEndpoint": "https://dashboard.example.com",
"gcpProjectID": "my-project",
"id": "hc-12345678",
"instanceID": "instance-12345678",
"region": "us-east-1",
"status": "READY",
"type": "Kubernetes"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"dashboardEndpoint": "https://dashboard.example.com",
"gcpProjectID": "my-project",
"id": "hc-12345678",
"instanceID": "instance-12345678",
"region": "us-east-1",
"status": "READY",
"type": "Kubernetes"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"dashboardEndpoint": "https://dashboard.example.com",
"gcpProjectID": "my-project",
"id": "hc-12345678",
"instanceID": "instance-12345678",
"region": "us-east-1",
"status": "READY",
"type": "Kubernetes"
}
],
"ids": ["sub-12345678",
"sub-abcdefgh",
"sub-1234efgh"
],
"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

Payload

Content type

application/json

{"resourceId": "r-12345678"
}

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.

Responses

Response samples

200

Content type

application/json

{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"backupStatus": {"backupPeriodInHours": 2,
"backupRetentionInDays": 7,
"earliestRestoreTime": "2021-09-01T00:00:00Z",
"lastBackupTime": "2021-09-01T00:00:00Z"
},
"cloud_provider": "aws",
"created_at": "2023-01-10T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"currentReplicas": "2",
"customNetworkDetail": {"cidr": "10.177.0.0/16",
"id": "n-12345678",
"name": "Prod us-east-1"
},
"detailedNetworkTopology": {"r-abcd1234": {"allowedIPRanges": ["0.0.0.0/0"
],
"clusterEndpoint": "primary.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"clusterPorts": [3306
],
"isJob": false,
"jobMetrics": [{"additionalData": {"exitCode": 0,
"status": "Succeeded"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "cpu_core_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 120.5
},
{"additionalData": {"peakMemoryUsage": "512MB"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "memory_mb_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 2560
}
],
"main": true,
"networkingType": "PUBLIC",
"nodes": [{"availabilityZone": "us-east-2a",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"healthStatus": "healthy",
"id": "primary-0",
"ports": [3306
],
"status": "RUNNING"
}
],
"privateNetworkCIDR": "10.0.0.2/24",
"privateNetworkID": "n-1234abcd",
"publiclyAccessible": true,
"resourceKey": "primary",
"resourceName": "Primary MySQL Instance"
}
},
"externalPayerId": "external-payer-id-1234",
"gcpProjectID": "my-project",
"highAvailability": true,
"id": "instance-abcd1234",
"instanceLoadStatus": "Tempora nemo deserunt id nisi.",
"kubernetesDashboardEndpoint": {"dashboardEndpoint": "https://kubernetes-dashboard.hc-12345678.region.cloudprovider.f2e0a955bb84.cloud/#/pod?namespace=instance-abcdefgh",
"deploymentCellID": "hc-12345678"
},
"last_modified_at": "2023-01-20T00:00:00Z",
"maintenanceTasks": {"Commodi quam quia velit voluptatem mollitia.": "Quia totam ut hic et.",
"Tenetur enim voluptatem quis.": "Illum nostrum rerum dolorem velit labore."
},
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC|INTERNAL",
"productTierFeatures": {"LOGS": {"auth": {"password": "px3c4d5f6g7h8i",
"username": "abcd1234"
},
"enabled": true,
"websocketBaseUrl": "wss://r-injectedobserve.instance-abcdefgh.us-east-2.aws.omnistrate.cloud/logs"
},
"METRICS": {"enabled": false
}
},
"region": "us-east-1",
"resourceID": "r-abcd1234",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234",
"subscriptionLicense": {"certificateBase64": "public-cert",
"expirationDate": "2024-01-01T10:00:00Z",
"licenseBase64": "license-file"
},
"subscriptionStatus": "ACTIVE"
},
"defaultSubscription": true,
"deploymentCellID": "hc-12345678",
"environmentId": "se-12345678",
"gcpProjectID": "my-project",
"input_params": {"param1": "value1",
"param2": "value2"
},
"instanceDebugCommands": ["aws eks update-kubeconfig --name my-cluster --region us-west-2",
"kubectl -n instance-12345678 get pods"
],
"integrationsStatus": [{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"maintenanceTasks": {"Consequatur facilis assumenda nemo accusamus vitae.": "Iure dolores ipsa enim quae esse."
},
"managedResourceType": "PortsBasedProxy",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"organizationId": "org-12345678",
"organizationName": "my-org",
"portsRegistrationStatus": {"instance-123": [30000,
30001
],
"instance-456": [30002,
30003
]
},
"productTierId": "pt-12345678",
"productTierName": "premium",
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceVersionSummaries": [{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
}
],
"serviceEnvName": "dev",
"serviceId": "s-12345678",
"serviceLogoURL": "Accusamus possimus quia.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"subscriptionStatus": "ACTIVE",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"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

network_type	string The network type
requestParams	any The request parameters
resourceId required	string The resource ID.

Responses

Request samples

Payload

Content type

application/json

{"network_type": "PUBLIC|INTERNAL",
"requestParams": {"param1": "value1",
"param2": "value2"
},
"resourceId": "r-12345678"
}

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

Payload

Content type

application/json

{"capacityToBeAdded": 3,
"resourceId": "r-12345678"
}

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

202

Content type

application/json

{"environmentId": "se-12345678",
"serviceId": "s-12345678",
"snapshotId": "instance-ss-12345678"
}

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

200

Content type

application/json

{"instanceId": "instance-12345678",
"resourcesDebug": {"Alias modi sit aliquid minus.": {"debugData": "Quibusdam dignissimos aperiam perspiciatis.",
"resourceId": "r-12345678"
},
"Doloribus incidunt reiciendis.": {"debugData": "Quibusdam dignissimos aperiam perspiciatis.",
"resourceId": "r-12345678"
},
"Voluptatem amet.": {"debugData": "Quibusdam dignissimos aperiam perspiciatis.",
"resourceId": "r-12345678"
}
}
}

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

Payload

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

200

Content type

application/json

{"environmentId": "se-12345678",
"nextPageToken": "next-token",
"resources": [{"environmentId": "se-12345678",
"instanceCount": 2,
"name": "asserts-server",
"perVersionInstanceCount": {"1.0": 2,
"1.1": 2,
"2.0": 2
},
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceId": "r-12345678",
"serviceId": "s-12345678",
"serviceModelType": "OMNISTRATE_HOSTED",
"version": "2.0",
"versionHistory": ["1.0",
"1.1",
"2.0"
]
},
{"environmentId": "se-12345678",
"instanceCount": 2,
"name": "asserts-server",
"perVersionInstanceCount": {"1.0": 2,
"1.1": 2,
"2.0": 2
},
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceId": "r-12345678",
"serviceId": "s-12345678",
"serviceModelType": "OMNISTRATE_HOSTED",
"version": "2.0",
"versionHistory": ["1.0",
"1.1",
"2.0"
]
}
],
"serviceId": "s-12345678"
}

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

200

Content type

application/json

{"environmentId": "se-12345678",
"eventSource": "Customer, Infra or Maintenance",
"id": "event-12345678",
"instanceId": "instance-12345678",
"message": "instance-abcd1234 created",
"orgId": "org-12345678",
"orgName": "Acme Corporation",
"resourceName": "Galera",
"serviceId": "s-12345678",
"time": "2023-01-10T00:00:00Z",
"userId": "user-12345678",
"userName": "John Doe",
"workflowFailures": [{"eventTime": "2020-01-01T00:00:00Z",
"message": "Bootstrap failed for reason X"
},
{"eventTime": "2020-01-01T00:01:00Z",
"message": "Compute failed for reason Y"
}
],
"workflowId": "workflow-12345678"
}

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

200

Content type

application/json

{"events": [{"environmentId": "se-12345678",
"eventSource": "Customer, Infra or Maintenance",
"id": "event-12345678",
"instanceId": "instance-12345678",
"message": "instance-abcd1234 created",
"orgId": "org-12345678",
"orgName": "Acme Corporation",
"resourceName": "Galera",
"serviceId": "s-12345678",
"time": "2023-01-10T00:00:00Z",
"userId": "user-12345678",
"userName": "John Doe",
"workflowFailures": [{"eventTime": "2020-01-01T00:00:00Z",
"message": "Bootstrap failed for reason X"
},
{"eventTime": "2020-01-01T00:01:00Z",
"message": "Compute failed for reason Y"
}
],
"workflowId": "workflow-12345678"
},
{"environmentId": "se-12345678",
"eventSource": "Customer, Infra or Maintenance",
"id": "event-12345678",
"instanceId": "instance-12345678",
"message": "instance-abcd1234 created",
"orgId": "org-12345678",
"orgName": "Acme Corporation",
"resourceName": "Galera",
"serviceId": "s-12345678",
"time": "2023-01-10T00:00:00Z",
"userId": "user-12345678",
"userName": "John Doe",
"workflowFailures": [{"eventTime": "2020-01-01T00:00:00Z",
"message": "Bootstrap failed for reason X"
},
{"eventTime": "2020-01-01T00:01:00Z",
"message": "Compute failed for reason Y"
}
],
"workflowId": "workflow-12345678"
},
{"environmentId": "se-12345678",
"eventSource": "Customer, Infra or Maintenance",
"id": "event-12345678",
"instanceId": "instance-12345678",
"message": "instance-abcd1234 created",
"orgId": "org-12345678",
"orgName": "Acme Corporation",
"resourceName": "Galera",
"serviceId": "s-12345678",
"time": "2023-01-10T00:00:00Z",
"userId": "user-12345678",
"userName": "John Doe",
"workflowFailures": [{"eventTime": "2020-01-01T00:00:00Z",
"message": "Bootstrap failed for reason X"
},
{"eventTime": "2020-01-01T00:01:00Z",
"message": "Compute failed for reason Y"
}
],
"workflowId": "workflow-12345678"
}
],
"ids": ["event-12345678"
],
"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

Payload

Content type

application/json

{"failedReplicaAction": "FAILOVER_AND_RESTART",
"failedReplicaID": "db-0"
}

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

200

Content type

application/json

{"environmentId": "se-12345678",
"nextPageToken": "next-token",
"resourceInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"backupStatus": {"backupPeriodInHours": 2,
"backupRetentionInDays": 7,
"earliestRestoreTime": "2021-09-01T00:00:00Z",
"lastBackupTime": "2021-09-01T00:00:00Z"
},
"cloud_provider": "aws",
"created_at": "2023-01-10T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"currentReplicas": "2",
"customNetworkDetail": {"cidr": "10.177.0.0/16",
"id": "n-12345678",
"name": "Prod us-east-1"
},
"detailedNetworkTopology": {"r-abcd1234": {"allowedIPRanges": ["0.0.0.0/0"
],
"clusterEndpoint": "primary.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"clusterPorts": [3306
],
"isJob": false,
"jobMetrics": [{"additionalData": {"exitCode": 0,
"status": "Succeeded"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "cpu_core_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 120.5
},
{"additionalData": {"peakMemoryUsage": "512MB"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "memory_mb_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 2560
}
],
"main": true,
"networkingType": "PUBLIC",
"nodes": [{"availabilityZone": "us-east-2a",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"healthStatus": "healthy",
"id": "primary-0",
"ports": [3306
],
"status": "RUNNING"
}
],
"privateNetworkCIDR": "10.0.0.2/24",
"privateNetworkID": "n-1234abcd",
"publiclyAccessible": true,
"resourceKey": "primary",
"resourceName": "Primary MySQL Instance"
}
},
"externalPayerId": "external-payer-id-1234",
"gcpProjectID": "my-project",
"highAvailability": true,
"id": "instance-abcd1234",
"instanceLoadStatus": "Tempora nemo deserunt id nisi.",
"kubernetesDashboardEndpoint": {"dashboardEndpoint": "https://kubernetes-dashboard.hc-12345678.region.cloudprovider.f2e0a955bb84.cloud/#/pod?namespace=instance-abcdefgh",
"deploymentCellID": "hc-12345678"
},
"last_modified_at": "2023-01-20T00:00:00Z",
"maintenanceTasks": {"Commodi quam quia velit voluptatem mollitia.": "Quia totam ut hic et.",
"Tenetur enim voluptatem quis.": "Illum nostrum rerum dolorem velit labore."
},
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC|INTERNAL",
"productTierFeatures": {"LOGS": {"auth": {"password": "px3c4d5f6g7h8i",
"username": "abcd1234"
},
"enabled": true,
"websocketBaseUrl": "wss://r-injectedobserve.instance-abcdefgh.us-east-2.aws.omnistrate.cloud/logs"
},
"METRICS": {"enabled": false
}
},
"region": "us-east-1",
"resourceID": "r-abcd1234",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234",
"subscriptionLicense": {"certificateBase64": "public-cert",
"expirationDate": "2024-01-01T10:00:00Z",
"licenseBase64": "license-file"
},
"subscriptionStatus": "ACTIVE"
},
"defaultSubscription": true,
"deploymentCellID": "hc-12345678",
"environmentId": "se-12345678",
"gcpProjectID": "my-project",
"input_params": {"param1": "value1",
"param2": "value2"
},
"instanceDebugCommands": ["aws eks update-kubeconfig --name my-cluster --region us-west-2",
"kubectl -n instance-12345678 get pods"
],
"integrationsStatus": [{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"maintenanceTasks": {"Est natus necessitatibus soluta laborum ut.": "Inventore cupiditate modi possimus.",
"Quisquam quia eveniet vel non.": "Expedita eligendi commodi ex asperiores."
},
"managedResourceType": "PortsBasedProxy",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"organizationId": "org-12345678",
"organizationName": "my-org",
"portsRegistrationStatus": {"instance-123": [30000,
30001
],
"instance-456": [30002,
30003
]
},
"productTierId": "pt-12345678",
"productTierName": "premium",
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceVersionSummaries": [{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
}
],
"serviceEnvName": "dev",
"serviceId": "s-12345678",
"serviceLogoURL": "Exercitationem harum optio.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"subscriptionStatus": "ACTIVE",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"backupStatus": {"backupPeriodInHours": 2,
"backupRetentionInDays": 7,
"earliestRestoreTime": "2021-09-01T00:00:00Z",
"lastBackupTime": "2021-09-01T00:00:00Z"
},
"cloud_provider": "aws",
"created_at": "2023-01-10T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"currentReplicas": "2",
"customNetworkDetail": {"cidr": "10.177.0.0/16",
"id": "n-12345678",
"name": "Prod us-east-1"
},
"detailedNetworkTopology": {"r-abcd1234": {"allowedIPRanges": ["0.0.0.0/0"
],
"clusterEndpoint": "primary.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"clusterPorts": [3306
],
"isJob": false,
"jobMetrics": [{"additionalData": {"exitCode": 0,
"status": "Succeeded"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "cpu_core_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 120.5
},
{"additionalData": {"peakMemoryUsage": "512MB"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "memory_mb_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 2560
}
],
"main": true,
"networkingType": "PUBLIC",
"nodes": [{"availabilityZone": "us-east-2a",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"healthStatus": "healthy",
"id": "primary-0",
"ports": [3306
],
"status": "RUNNING"
}
],
"privateNetworkCIDR": "10.0.0.2/24",
"privateNetworkID": "n-1234abcd",
"publiclyAccessible": true,
"resourceKey": "primary",
"resourceName": "Primary MySQL Instance"
}
},
"externalPayerId": "external-payer-id-1234",
"gcpProjectID": "my-project",
"highAvailability": true,
"id": "instance-abcd1234",
"instanceLoadStatus": "Tempora nemo deserunt id nisi.",
"kubernetesDashboardEndpoint": {"dashboardEndpoint": "https://kubernetes-dashboard.hc-12345678.region.cloudprovider.f2e0a955bb84.cloud/#/pod?namespace=instance-abcdefgh",
"deploymentCellID": "hc-12345678"
},
"last_modified_at": "2023-01-20T00:00:00Z",
"maintenanceTasks": {"Commodi quam quia velit voluptatem mollitia.": "Quia totam ut hic et.",
"Tenetur enim voluptatem quis.": "Illum nostrum rerum dolorem velit labore."
},
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC|INTERNAL",
"productTierFeatures": {"LOGS": {"auth": {"password": "px3c4d5f6g7h8i",
"username": "abcd1234"
},
"enabled": true,
"websocketBaseUrl": "wss://r-injectedobserve.instance-abcdefgh.us-east-2.aws.omnistrate.cloud/logs"
},
"METRICS": {"enabled": false
}
},
"region": "us-east-1",
"resourceID": "r-abcd1234",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234",
"subscriptionLicense": {"certificateBase64": "public-cert",
"expirationDate": "2024-01-01T10:00:00Z",
"licenseBase64": "license-file"
},
"subscriptionStatus": "ACTIVE"
},
"defaultSubscription": true,
"deploymentCellID": "hc-12345678",
"environmentId": "se-12345678",
"gcpProjectID": "my-project",
"input_params": {"param1": "value1",
"param2": "value2"
},
"instanceDebugCommands": ["aws eks update-kubeconfig --name my-cluster --region us-west-2",
"kubectl -n instance-12345678 get pods"
],
"integrationsStatus": [{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"maintenanceTasks": {"Est natus necessitatibus soluta laborum ut.": "Inventore cupiditate modi possimus.",
"Quisquam quia eveniet vel non.": "Expedita eligendi commodi ex asperiores."
},
"managedResourceType": "PortsBasedProxy",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"organizationId": "org-12345678",
"organizationName": "my-org",
"portsRegistrationStatus": {"instance-123": [30000,
30001
],
"instance-456": [30002,
30003
]
},
"productTierId": "pt-12345678",
"productTierName": "premium",
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceVersionSummaries": [{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
}
],
"serviceEnvName": "dev",
"serviceId": "s-12345678",
"serviceLogoURL": "Exercitationem harum optio.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"subscriptionStatus": "ACTIVE",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
}
],
"serviceId": "s-12345678"
}

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

Payload

Content type

application/json

{"capacityToBeRemoved": 3,
"resourceId": "r-12345678"
}

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

Payload

Content type

application/json

{"resourceId": "r-12345678"
}

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

Payload

Content type

application/json

{"targetRestoreTime": "2021-09-01T00:00:00Z"
}

Response samples

200

Content type

application/json

{"completeTime": "2021-09-01T00:00:00Z",
"environmentId": "se-12345678",
"productTierId": "pt-12345678",
"productTierVersion": "1.0",
"serviceId": "s-12345678",
"snapshotId": "instance-ss-12345678",
"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

Payload

Content type

application/json

{"network_type": "PUBLIC|INTERNAL",
"targetRestoreTime": "2021-09-01T00:00:00Z"
}

Response samples

202

Content type

application/json

{"id": "Sunt quia mollitia autem perspiciatis inventore."
}

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

200

Content type

application/json

{"snapshots": [{"completeTime": "2021-09-01T00:00:00Z",
"createdTime": "2021-09-01T00:00:00Z",
"encrypted": true,
"environmentId": "se-12345678",
"productTierId": "pt-12345678",
"productTierVersion": "1.0",
"progress": 99,
"serviceId": "s-12345678",
"snapshotId": "instance-ss-12345678",
"sourceInstanceId": "instance-12345678",
"status": "completed"
},
{"completeTime": "2021-09-01T00:00:00Z",
"createdTime": "2021-09-01T00:00:00Z",
"encrypted": true,
"environmentId": "se-12345678",
"productTierId": "pt-12345678",
"productTierVersion": "1.0",
"progress": 99,
"serviceId": "s-12345678",
"snapshotId": "instance-ss-12345678",
"sourceInstanceId": "instance-12345678",
"status": "completed"
},
{"completeTime": "2021-09-01T00:00:00Z",
"createdTime": "2021-09-01T00:00:00Z",
"encrypted": true,
"environmentId": "se-12345678",
"productTierId": "pt-12345678",
"productTierVersion": "1.0",
"progress": 99,
"serviceId": "s-12345678",
"snapshotId": "instance-ss-12345678",
"sourceInstanceId": "instance-12345678",
"status": "completed"
}
]
}

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

202

Content type

application/json

{"environmentId": "se-12345678",
"serviceId": "s-12345678",
"snapshotId": "instance-ss-12345678"
}

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.
instanceId required	string Example: instance-12345678 The resource instance ID.
snapshotId required	string Example: instance-ss-12345678 The instance snapshot ID

Responses

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

200

Content type

application/json

{"completeTime": "2021-09-01T00:00:00Z",
"createdTime": "2021-09-01T00:00:00Z",
"encrypted": true,
"environmentId": "se-12345678",
"productTierId": "pt-12345678",
"productTierVersion": "1.0",
"progress": 99,
"serviceId": "s-12345678",
"snapshotId": "instance-ss-12345678",
"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

Payload

Content type

application/json

{"resourceId": "r-12345678"
}

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

Payload

Content type

application/json

{"resourceId": "r-12345678"
}

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=At totam excepturi quia. Product tier version of the instance to describe. If not specified, the latest version is described.
ProductTierId	string Example: ProductTierId=Eum officiis et. Product tier id of the instance to describe. Needs to specified in combination with the product tier version
SubscriptionId	string Example: SubscriptionId=Quisquam officiis occaecati rerum iusto atque itaque. Subscription id of the instance to describe.
Filter	string Enum: "onlyCloudAccounts" "excludeCloudAccounts" Example: Filter=onlyCloudAccounts Filter to apply to the list of instances.

Responses

Response samples

200

Content type

application/json

{"environmentId": "se-12345678",
"nextPageToken": "next-token",
"resourceInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"backupStatus": {"backupPeriodInHours": 2,
"backupRetentionInDays": 7,
"earliestRestoreTime": "2021-09-01T00:00:00Z",
"lastBackupTime": "2021-09-01T00:00:00Z"
},
"cloud_provider": "aws",
"created_at": "2023-01-10T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"currentReplicas": "2",
"customNetworkDetail": {"cidr": "10.177.0.0/16",
"id": "n-12345678",
"name": "Prod us-east-1"
},
"detailedNetworkTopology": {"r-abcd1234": {"allowedIPRanges": ["0.0.0.0/0"
],
"clusterEndpoint": "primary.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"clusterPorts": [3306
],
"isJob": false,
"jobMetrics": [{"additionalData": {"exitCode": 0,
"status": "Succeeded"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "cpu_core_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 120.5
},
{"additionalData": {"peakMemoryUsage": "512MB"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "memory_mb_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 2560
}
],
"main": true,
"networkingType": "PUBLIC",
"nodes": [{"availabilityZone": "us-east-2a",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"healthStatus": "healthy",
"id": "primary-0",
"ports": [3306
],
"status": "RUNNING"
}
],
"privateNetworkCIDR": "10.0.0.2/24",
"privateNetworkID": "n-1234abcd",
"publiclyAccessible": true,
"resourceKey": "primary",
"resourceName": "Primary MySQL Instance"
}
},
"externalPayerId": "external-payer-id-1234",
"gcpProjectID": "my-project",
"highAvailability": true,
"id": "instance-abcd1234",
"instanceLoadStatus": "Tempora nemo deserunt id nisi.",
"kubernetesDashboardEndpoint": {"dashboardEndpoint": "https://kubernetes-dashboard.hc-12345678.region.cloudprovider.f2e0a955bb84.cloud/#/pod?namespace=instance-abcdefgh",
"deploymentCellID": "hc-12345678"
},
"last_modified_at": "2023-01-20T00:00:00Z",
"maintenanceTasks": {"Commodi quam quia velit voluptatem mollitia.": "Quia totam ut hic et.",
"Tenetur enim voluptatem quis.": "Illum nostrum rerum dolorem velit labore."
},
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC|INTERNAL",
"productTierFeatures": {"LOGS": {"auth": {"password": "px3c4d5f6g7h8i",
"username": "abcd1234"
},
"enabled": true,
"websocketBaseUrl": "wss://r-injectedobserve.instance-abcdefgh.us-east-2.aws.omnistrate.cloud/logs"
},
"METRICS": {"enabled": false
}
},
"region": "us-east-1",
"resourceID": "r-abcd1234",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234",
"subscriptionLicense": {"certificateBase64": "public-cert",
"expirationDate": "2024-01-01T10:00:00Z",
"licenseBase64": "license-file"
},
"subscriptionStatus": "ACTIVE"
},
"defaultSubscription": true,
"deploymentCellID": "hc-12345678",
"environmentId": "se-12345678",
"gcpProjectID": "my-project",
"input_params": {"param1": "value1",
"param2": "value2"
},
"instanceDebugCommands": ["aws eks update-kubeconfig --name my-cluster --region us-west-2",
"kubectl -n instance-12345678 get pods"
],
"integrationsStatus": [{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"maintenanceTasks": {"Est natus necessitatibus soluta laborum ut.": "Inventore cupiditate modi possimus.",
"Quisquam quia eveniet vel non.": "Expedita eligendi commodi ex asperiores."
},
"managedResourceType": "PortsBasedProxy",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"organizationId": "org-12345678",
"organizationName": "my-org",
"portsRegistrationStatus": {"instance-123": [30000,
30001
],
"instance-456": [30002,
30003
]
},
"productTierId": "pt-12345678",
"productTierName": "premium",
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceVersionSummaries": [{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
}
],
"serviceEnvName": "dev",
"serviceId": "s-12345678",
"serviceLogoURL": "Exercitationem harum optio.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"subscriptionStatus": "ACTIVE",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"backupStatus": {"backupPeriodInHours": 2,
"backupRetentionInDays": 7,
"earliestRestoreTime": "2021-09-01T00:00:00Z",
"lastBackupTime": "2021-09-01T00:00:00Z"
},
"cloud_provider": "aws",
"created_at": "2023-01-10T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"currentReplicas": "2",
"customNetworkDetail": {"cidr": "10.177.0.0/16",
"id": "n-12345678",
"name": "Prod us-east-1"
},
"detailedNetworkTopology": {"r-abcd1234": {"allowedIPRanges": ["0.0.0.0/0"
],
"clusterEndpoint": "primary.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"clusterPorts": [3306
],
"isJob": false,
"jobMetrics": [{"additionalData": {"exitCode": 0,
"status": "Succeeded"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "cpu_core_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 120.5
},
{"additionalData": {"peakMemoryUsage": "512MB"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "memory_mb_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 2560
}
],
"main": true,
"networkingType": "PUBLIC",
"nodes": [{"availabilityZone": "us-east-2a",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"healthStatus": "healthy",
"id": "primary-0",
"ports": [3306
],
"status": "RUNNING"
}
],
"privateNetworkCIDR": "10.0.0.2/24",
"privateNetworkID": "n-1234abcd",
"publiclyAccessible": true,
"resourceKey": "primary",
"resourceName": "Primary MySQL Instance"
}
},
"externalPayerId": "external-payer-id-1234",
"gcpProjectID": "my-project",
"highAvailability": true,
"id": "instance-abcd1234",
"instanceLoadStatus": "Tempora nemo deserunt id nisi.",
"kubernetesDashboardEndpoint": {"dashboardEndpoint": "https://kubernetes-dashboard.hc-12345678.region.cloudprovider.f2e0a955bb84.cloud/#/pod?namespace=instance-abcdefgh",
"deploymentCellID": "hc-12345678"
},
"last_modified_at": "2023-01-20T00:00:00Z",
"maintenanceTasks": {"Commodi quam quia velit voluptatem mollitia.": "Quia totam ut hic et.",
"Tenetur enim voluptatem quis.": "Illum nostrum rerum dolorem velit labore."
},
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC|INTERNAL",
"productTierFeatures": {"LOGS": {"auth": {"password": "px3c4d5f6g7h8i",
"username": "abcd1234"
},
"enabled": true,
"websocketBaseUrl": "wss://r-injectedobserve.instance-abcdefgh.us-east-2.aws.omnistrate.cloud/logs"
},
"METRICS": {"enabled": false
}
},
"region": "us-east-1",
"resourceID": "r-abcd1234",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234",
"subscriptionLicense": {"certificateBase64": "public-cert",
"expirationDate": "2024-01-01T10:00:00Z",
"licenseBase64": "license-file"
},
"subscriptionStatus": "ACTIVE"
},
"defaultSubscription": true,
"deploymentCellID": "hc-12345678",
"environmentId": "se-12345678",
"gcpProjectID": "my-project",
"input_params": {"param1": "value1",
"param2": "value2"
},
"instanceDebugCommands": ["aws eks update-kubeconfig --name my-cluster --region us-west-2",
"kubectl -n instance-12345678 get pods"
],
"integrationsStatus": [{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"maintenanceTasks": {"Est natus necessitatibus soluta laborum ut.": "Inventore cupiditate modi possimus.",
"Quisquam quia eveniet vel non.": "Expedita eligendi commodi ex asperiores."
},
"managedResourceType": "PortsBasedProxy",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"organizationId": "org-12345678",
"organizationName": "my-org",
"portsRegistrationStatus": {"instance-123": [30000,
30001
],
"instance-456": [30002,
30003
]
},
"productTierId": "pt-12345678",
"productTierName": "premium",
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceVersionSummaries": [{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
}
],
"serviceEnvName": "dev",
"serviceId": "s-12345678",
"serviceLogoURL": "Exercitationem harum optio.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"subscriptionStatus": "ACTIVE",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"azureSubscriptionID": "0fa05079-dd73-4b88-babc-05537817604a",
"backupStatus": {"backupPeriodInHours": 2,
"backupRetentionInDays": 7,
"earliestRestoreTime": "2021-09-01T00:00:00Z",
"lastBackupTime": "2021-09-01T00:00:00Z"
},
"cloud_provider": "aws",
"created_at": "2023-01-10T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"currentReplicas": "2",
"customNetworkDetail": {"cidr": "10.177.0.0/16",
"id": "n-12345678",
"name": "Prod us-east-1"
},
"detailedNetworkTopology": {"r-abcd1234": {"allowedIPRanges": ["0.0.0.0/0"
],
"clusterEndpoint": "primary.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"clusterPorts": [3306
],
"isJob": false,
"jobMetrics": [{"additionalData": {"exitCode": 0,
"status": "Succeeded"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "cpu_core_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 120.5
},
{"additionalData": {"peakMemoryUsage": "512MB"
},
"endTime": "2023-01-01T10:05:00Z",
"metricType": "memory_mb_seconds",
"startTime": "2023-01-01T10:00:00Z",
"value": 2560
}
],
"main": true,
"networkingType": "PUBLIC",
"nodes": [{"availabilityZone": "us-east-2a",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"healthStatus": "healthy",
"id": "primary-0",
"ports": [3306
],
"status": "RUNNING"
}
],
"privateNetworkCIDR": "10.0.0.2/24",
"privateNetworkID": "n-1234abcd",
"publiclyAccessible": true,
"resourceKey": "primary",
"resourceName": "Primary MySQL Instance"
}
},
"externalPayerId": "external-payer-id-1234",
"gcpProjectID": "my-project",
"highAvailability": true,
"id": "instance-abcd1234",
"instanceLoadStatus": "Tempora nemo deserunt id nisi.",
"kubernetesDashboardEndpoint": {"dashboardEndpoint": "https://kubernetes-dashboard.hc-12345678.region.cloudprovider.f2e0a955bb84.cloud/#/pod?namespace=instance-abcdefgh",
"deploymentCellID": "hc-12345678"
},
"last_modified_at": "2023-01-20T00:00:00Z",
"maintenanceTasks": {"Commodi quam quia velit voluptatem mollitia.": "Quia totam ut hic et.",
"Tenetur enim voluptatem quis.": "Illum nostrum rerum dolorem velit labore."
},
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC|INTERNAL",
"productTierFeatures": {"LOGS": {"auth": {"password": "px3c4d5f6g7h8i",
"username": "abcd1234"
},
"enabled": true,
"websocketBaseUrl": "wss://r-injectedobserve.instance-abcdefgh.us-east-2.aws.omnistrate.cloud/logs"
},
"METRICS": {"enabled": false
}
},
"region": "us-east-1",
"resourceID": "r-abcd1234",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234",
"subscriptionLicense": {"certificateBase64": "public-cert",
"expirationDate": "2024-01-01T10:00:00Z",
"licenseBase64": "license-file"
},
"subscriptionStatus": "ACTIVE"
},
"defaultSubscription": true,
"deploymentCellID": "hc-12345678",
"environmentId": "se-12345678",
"gcpProjectID": "my-project",
"input_params": {"param1": "value1",
"param2": "value2"
},
"instanceDebugCommands": ["aws eks update-kubeconfig --name my-cluster --region us-west-2",
"kubectl -n instance-12345678 get pods"
],
"integrationsStatus": [{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"configuration": {"provider": "native"
},
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"maintenanceTasks": {"Est natus necessitatibus soluta laborum ut.": "Inventore cupiditate modi possimus.",
"Quisquam quia eveniet vel non.": "Expedita eligendi commodi ex asperiores."
},
"managedResourceType": "PortsBasedProxy",
"manualOverride": {"setAt": "2020-01-01T00:00:00Z",
"setterUserId": "user-12345678",
"workflowId": "wf-12345678"
},
"organizationId": "org-12345678",
"organizationName": "my-org",
"portsRegistrationStatus": {"instance-123": [30000,
30001
],
"instance-456": [30002,
30003
]
},
"productTierId": "pt-12345678",
"productTierName": "premium",
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceVersionSummaries": [{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
},
{"capabilities": [{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
},
{"capability": "SERVERLESS",
"configuration": {"EnableAutoStop": true,
"MinimumNodesInPool": 5,
"PortsMappingProxyConfig": {"MaxNumberOfClustersPerProxyInstance": 50,
"NumberOfPortsPerCluster": 4
},
"ProxyId": "r-123456",
"ReferenceProxyKey": "resource-proxy",
"TargetPort": 5432
}
}
],
"externalResource": true,
"latestVersion": "2.0",
"resourceId": "r-12345678",
"resourceName": "asserts-server",
"version": "1.0"
}
],
"serviceEnvName": "dev",
"serviceId": "s-12345678",
"serviceLogoURL": "Exercitationem harum optio.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"subscriptionStatus": "ACTIVE",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
}
],
"serviceId": "s-12345678"
}

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

200

Content type

application/json

{"environmentId": "se-12345678",
"instanceCount": 2,
"name": "asserts-server",
"perVersionInstanceCount": {"1.0": 2,
"1.1": 2,
"2.0": 2
},
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceId": "r-12345678",
"serviceId": "s-12345678",
"serviceModelType": "OMNISTRATE_HOSTED",
"version": "2.0",
"versionHistory": ["1.0",
"1.1",
"2.0"
]
}

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

Payload

Content type

application/json

{"environmentType": "PROD",
"nextPageToken": "next-token",
"orgId": "org-12345678",
"pageSize": 10,
"userId": "user-12345678"
}

Response samples

200

Content type

application/json

{"environmentId": "se-12345678",
"nextPageToken": "next-token",
"resources": [{"environmentId": "se-12345678",
"instanceCount": 2,
"name": "asserts-server",
"perVersionInstanceCount": {"1.0": 2,
"1.1": 2,
"2.0": 2
},
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceId": "r-12345678",
"serviceId": "s-12345678",
"serviceModelType": "OMNISTRATE_HOSTED",
"version": "2.0",
"versionHistory": ["1.0",
"1.1",
"2.0"
]
},
{"environmentId": "se-12345678",
"instanceCount": 2,
"name": "asserts-server",
"perVersionInstanceCount": {"1.0": 2,
"1.1": 2,
"2.0": 2
},
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceId": "r-12345678",
"serviceId": "s-12345678",
"serviceModelType": "OMNISTRATE_HOSTED",
"version": "2.0",
"versionHistory": ["1.0",
"1.1",
"2.0"
]
},
{"environmentId": "se-12345678",
"instanceCount": 2,
"name": "asserts-server",
"perVersionInstanceCount": {"1.0": 2,
"1.1": 2,
"2.0": 2
},
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceId": "r-12345678",
"serviceId": "s-12345678",
"serviceModelType": "OMNISTRATE_HOSTED",
"version": "2.0",
"versionHistory": ["1.0",
"1.1",
"2.0"
]
},
{"environmentId": "se-12345678",
"instanceCount": 2,
"name": "asserts-server",
"perVersionInstanceCount": {"1.0": 2,
"1.1": 2,
"2.0": 2
},
"productTierType": "OMNISTRATE_DEDICATED",
"proxyType": "PortsBasedProxy",
"resourceId": "r-12345678",
"serviceId": "s-12345678",
"serviceModelType": "OMNISTRATE_HOSTED",
"version": "2.0",
"versionHistory": ["1.0",
"1.1",
"2.0"
]
}
],
"serviceId": "s-12345678"
}

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

200

Content type

application/json

{"email": "omnistrate-devops@examplecorp.com",
"orgId": "o-12345678",
"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

200

Content type

application/json

{"environmentId": "se-12345678",
"nextPageToken": "next-token",
"organizations": [{"email": "omnistrate-devops@examplecorp.com",
"orgId": "o-12345678",
"orgName": "Acme Corp",
"orgUrl": "omnistrate.com"
},
{"email": "omnistrate-devops@examplecorp.com",
"orgId": "o-12345678",
"orgName": "Acme Corp",
"orgUrl": "omnistrate.com"
},
{"email": "omnistrate-devops@examplecorp.com",
"orgId": "o-12345678",
"orgName": "Acme Corp",
"orgUrl": "omnistrate.com"
}
],
"serviceId": "s-12345678"
}

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

Payload

Content type

application/json

{"query": "foo"
}

Response samples

200

Content type

application/json

{"results": [{"description": "The PostgresDB for Omnistrate.",
"id": "r-12345678",
"name": "postgres",
"status": "Ready",
"statusDescription": "The PostgresDB for Omnistrate is ready."
}
],
"serviceId": "s-12345678"
}

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

200

Content type

application/json

{"EnvironmentCount": 1,
"ImagesCount": 1,
"InfraConfigCount": 1,
"InstancesCount": 1,
"OrganizationCount": 1,
"ResourceCount": 1,
"UserCount": 1,
"environmentId": "se-12345678",
"serviceId": "s-12345678"
}

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

inputParametersOverride	any Custom input parameters override
network_type	string The network type
productTierVersionOverride	string The product tier version

Responses

Request samples

Payload

Content type

application/json

{"inputParametersOverride": {"param1": "value1",
"param2": "value2"
},
"network_type": "PUBLIC|INTERNAL",
"productTierVersionOverride": "1.0"
}

Response samples

202

Content type

application/json

{"id": "Et sapiente neque autem sint tempore."
}

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

Responses

Response samples

200

Content type

application/json

{"ids": ["sub-12345678",
"sub-abcdefgh",
"sub-1234efgh"
],
"nextPageToken": "next-token",
"subscriptions": [{"activeSubscriptionPricing": {"CPU core hours": {"amount": 0.001,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.0001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.0001,
"currency": "USD"
}
},
"createdAt": "2019-01-01T00:00:00Z",
"externalPayerId": "a3df-sdf9-gfn3-4g3f",
"historySubscriptionPricing": [{"createdAt": "2019-01-03T00:00:00Z",
"endDate": "2019-01-01T00:00:00Z",
"inheritServicePlanPrice": true,
"pricePerUnit": {"CPU core hours": {"amount": 0.001,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.0001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.0001,
"currency": "USD"
}
}
},
{"createdAt": "2019-01-04T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"inheritServicePlanPrice": false,
"pricePerUnit": {"CPU core hours": {"amount": 0.01,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.001,
"currency": "USD"
}
},
"startDate": "2019-01-01T00:00:00Z"
}
],
"id": "sub-12345678",
"inheritServicePlanPrice": true,
"instanceCount": 3,
"paymentChannel": {"isDefault": true,
"name": "Stripe",
"type": "STRIPE"
},
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"rootUserEmail": "abc@gmail.com",
"rootUserId": "user-12345678",
"rootUserName": "John Doe",
"rootUserOrgId": "org-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Reiciendis autem expedita ea magnam.",
"serviceName": "MySQL multi-writer service",
"status": "ACTIVE",
"updatedAt": "2019-01-01T00:00:00Z",
"updatedByUserId": "user-12345678",
"updatedByUserName": "John Doe",
"updatedByUserOrgId": "org-12345678"
},
{"activeSubscriptionPricing": {"CPU core hours": {"amount": 0.001,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.0001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.0001,
"currency": "USD"
}
},
"createdAt": "2019-01-01T00:00:00Z",
"externalPayerId": "a3df-sdf9-gfn3-4g3f",
"historySubscriptionPricing": [{"createdAt": "2019-01-03T00:00:00Z",
"endDate": "2019-01-01T00:00:00Z",
"inheritServicePlanPrice": true,
"pricePerUnit": {"CPU core hours": {"amount": 0.001,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.0001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.0001,
"currency": "USD"
}
}
},
{"createdAt": "2019-01-04T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"inheritServicePlanPrice": false,
"pricePerUnit": {"CPU core hours": {"amount": 0.01,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.001,
"currency": "USD"
}
},
"startDate": "2019-01-01T00:00:00Z"
}
],
"id": "sub-12345678",
"inheritServicePlanPrice": true,
"instanceCount": 3,
"paymentChannel": {"isDefault": true,
"name": "Stripe",
"type": "STRIPE"
},
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"rootUserEmail": "abc@gmail.com",
"rootUserId": "user-12345678",
"rootUserName": "John Doe",
"rootUserOrgId": "org-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Reiciendis autem expedita ea magnam.",
"serviceName": "MySQL multi-writer service",
"status": "ACTIVE",
"updatedAt": "2019-01-01T00:00:00Z",
"updatedByUserId": "user-12345678",
"updatedByUserName": "John Doe",
"updatedByUserOrgId": "org-12345678"
}
]
}

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

externalPayerId	string The external payer ID to record which customer should pay for this subscription
inheritServicePlanPrice	boolean Whether to inherit the service plan price
onBehalfOfCustomerUserId required	string The user ID of the customer that this subscription is on behalf of
paymentChannelType	string The payment channel type to use for this subscription
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.
	object If inheritServicePlanPrice is false, provide the price per unit for the subscription here.
productTierId required	string The product tier ID

Responses

Request samples

Payload

Content type

application/json

{"externalPayerId": "a3df-sdf9-gfn3-4g3f",
"inheritServicePlanPrice": true,
"onBehalfOfCustomerUserId": "user-12345678",
"paymentChannelType": "STRIPE",
"priceEffectiveDate": "2019-01-01T00:00:00Z",
"pricePerUnit": {"CPU core hours": {"amount": 0.001,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.0001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.0001,
"currency": "USD"
}
},
"productTierId": "prod-12345678"
}

Response samples

200

Content type

application/json

{"id": "sub-12345678"
}

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

200

Content type

application/json

{"activeSubscriptionPricing": {"CPU core hours": {"amount": 0.001,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.0001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.0001,
"currency": "USD"
}
},
"createdAt": "2019-01-01T00:00:00Z",
"externalPayerId": "a3df-sdf9-gfn3-4g3f",
"historySubscriptionPricing": [{"createdAt": "2019-01-03T00:00:00Z",
"endDate": "2019-01-01T00:00:00Z",
"inheritServicePlanPrice": true,
"pricePerUnit": {"CPU core hours": {"amount": 0.001,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.0001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.0001,
"currency": "USD"
}
}
},
{"createdAt": "2019-01-04T00:00:00Z",
"createdByUserId": "user-12345678",
"createdByUserName": "John Doe",
"inheritServicePlanPrice": false,
"pricePerUnit": {"CPU core hours": {"amount": 0.01,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.001,
"currency": "USD"
}
},
"startDate": "2019-01-01T00:00:00Z"
}
],
"id": "sub-12345678",
"inheritServicePlanPrice": true,
"instanceCount": 3,
"paymentChannel": {"isDefault": true,
"name": "Stripe",
"type": "STRIPE"
},
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"rootUserEmail": "abc@gmail.com",
"rootUserId": "user-12345678",
"rootUserName": "John Doe",
"rootUserOrgId": "org-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Beatae cumque ipsa et.",
"serviceName": "MySQL multi-writer service",
"status": "ACTIVE",
"updatedAt": "2019-01-01T00:00:00Z",
"updatedByUserId": "user-12345678",
"updatedByUserName": "John Doe",
"updatedByUserOrgId": "org-12345678"
}

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

externalPayerId	string The external payer ID to record which customer should pay for this subscription.
inheritServicePlanPrice	boolean Whether to inherit the service plan price
paymentChannelType	string The payment channel type to use for this subscription
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.
	object If inheritServicePlanPrice is false, provide the price per unit for the subscription here.

Responses

Request samples

Payload

Content type

application/json

{"externalPayerId": "a3df-sdf9-gfn3-4g3f",
"inheritServicePlanPrice": true,
"paymentChannelType": "STRIPE",
"priceEffectiveDate": "2019-01-01T00:00:00Z",
"pricePerUnit": {"CPU core hours": {"amount": 0.001,
"currency": "USD"
},
"Memory GiB hours": {"amount": 0.0001,
"currency": "USD"
},
"Storage GiB hours": {"amount": 0.0001,
"currency": "USD"
}
}
}

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

200

Content type

application/json

{"ids": ["subr-12345678",
"subr-abcdefgh",
"subr-1234efgh"
],
"nextPageToken": "next-token",
"subscriptionRequests": [{"createdAt": "2019-01-01T00:00:00Z",
"id": "subr-12345678",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"rootUserEmail": "abc@gmail.com",
"rootUserId": "org-12345678",
"rootUserName": "John Doe",
"serviceId": "s-12345678",
"serviceLogoURL": "Harum quasi.",
"serviceName": "MySQL multi-writer service",
"status": "PENDING",
"updatedAt": "2019-01-01T00:00:00Z",
"updatedByUserId": "user-12345678",
"updatedByUserName": "John Doe"
},
{"createdAt": "2019-01-01T00:00:00Z",
"id": "subr-12345678",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"rootUserEmail": "abc@gmail.com",
"rootUserId": "org-12345678",
"rootUserName": "John Doe",
"serviceId": "s-12345678",
"serviceLogoURL": "Harum quasi.",
"serviceName": "MySQL multi-writer service",
"status": "PENDING",
"updatedAt": "2019-01-01T00:00:00Z",
"updatedByUserId": "user-12345678",
"updatedByUserName": "John Doe"
},
{"createdAt": "2019-01-01T00:00:00Z",
"id": "subr-12345678",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"rootUserEmail": "abc@gmail.com",
"rootUserId": "org-12345678",
"rootUserName": "John Doe",
"serviceId": "s-12345678",
"serviceLogoURL": "Harum quasi.",
"serviceName": "MySQL multi-writer service",
"status": "PENDING",
"updatedAt": "2019-01-01T00:00:00Z",
"updatedByUserId": "user-12345678",
"updatedByUserName": "John Doe"
}
]
}

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

200

Content type

application/json

{"createdAt": "2019-01-01T00:00:00Z",
"id": "subr-12345678",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"rootUserEmail": "abc@gmail.com",
"rootUserId": "org-12345678",
"rootUserName": "John Doe",
"serviceId": "s-12345678",
"serviceLogoURL": "Doloribus corporis ipsum.",
"serviceName": "MySQL multi-writer service",
"status": "PENDING",
"updatedAt": "2019-01-01T00:00:00Z",
"updatedByUserId": "user-12345678",
"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

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

200

Content type

application/json

{"createdAt": "2021-01-01T00:00:00Z",
"email": "alice@enterprise.com",
"enabled": true,
"lastModifiedAt": "2021-01-01T00:00:00Z",
"lastModifiedByUserID": "user-12345678",
"lastModifiedByUserName": "Alice",
"orgId": "org-12345678",
"orgName": "Enterprise",
"orgUrl": "https://enterprise.com",
"status": "ACTIVE",
"subscriptions": [{"cloudProviderNames": ["aws",
"gcp"
],
"defaultSubscription": true,
"email": "abc@gmail.com",
"instanceCount": 3,
"name": "John Dae",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"roleType": "reader",
"serviceEnvironmentId": "se-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Qui dolorem nemo velit harum voluptatem.",
"serviceName": "MySQL multi-writer service",
"subscriptionDate": "2019-01-01T00:00:00Z",
"subscriptionId": "sub-abcd1234",
"subscriptionOwnerName": "John Doe",
"userId": "[]user-abcd1234"
},
{"cloudProviderNames": ["aws",
"gcp"
],
"defaultSubscription": true,
"email": "abc@gmail.com",
"instanceCount": 3,
"name": "John Dae",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"roleType": "reader",
"serviceEnvironmentId": "se-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Qui dolorem nemo velit harum voluptatem.",
"serviceName": "MySQL multi-writer service",
"subscriptionDate": "2019-01-01T00:00:00Z",
"subscriptionId": "sub-abcd1234",
"subscriptionOwnerName": "John Doe",
"userId": "[]user-abcd1234"
},
{"cloudProviderNames": ["aws",
"gcp"
],
"defaultSubscription": true,
"email": "abc@gmail.com",
"instanceCount": 3,
"name": "John Dae",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"roleType": "reader",
"serviceEnvironmentId": "se-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Qui dolorem nemo velit harum voluptatem.",
"serviceName": "MySQL multi-writer service",
"subscriptionDate": "2019-01-01T00:00:00Z",
"subscriptionId": "sub-abcd1234",
"subscriptionOwnerName": "John Doe",
"userId": "[]user-abcd1234"
}
],
"token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
"userId": "user-12345678",
"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

subscriptionId

string

Example: subscriptionId=sub-12345678

The subscription ID of the user

Responses

Response samples

200

Content type

application/json

{"environmentId": "se-12345678",
"nextPageToken": "next-token",
"serviceId": "s-12345678",
"users": [{"createdAt": "2021-01-01T00:00:00Z",
"email": "alice@enterprise.com",
"enabled": true,
"environmentId": "se-12345678",
"instanceCount": 3,
"lastModifiedAt": "2021-01-01T00:00:00Z",
"lastModifiedByUserID": "user-12345678",
"lastModifiedByUserName": "Alice",
"orgId": "org-12345678",
"orgName": "Enterprise",
"orgUrl": "https://enterprise.com",
"serviceId": "s-12345678",
"status": "ACTIVE",
"subscriptionCount": 3,
"token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
"userId": "user-12345678",
"userName": "Alice",
"userSubscriptionRole": "root"
},
{"createdAt": "2021-01-01T00:00:00Z",
"email": "alice@enterprise.com",
"enabled": true,
"environmentId": "se-12345678",
"instanceCount": 3,
"lastModifiedAt": "2021-01-01T00:00:00Z",
"lastModifiedByUserID": "user-12345678",
"lastModifiedByUserName": "Alice",
"orgId": "org-12345678",
"orgName": "Enterprise",
"orgUrl": "https://enterprise.com",
"serviceId": "s-12345678",
"status": "ACTIVE",
"subscriptionCount": 3,
"token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
"userId": "user-12345678",
"userName": "Alice",
"userSubscriptionRole": "root"
},
{"createdAt": "2021-01-01T00:00:00Z",
"email": "alice@enterprise.com",
"enabled": true,
"environmentId": "se-12345678",
"instanceCount": 3,
"lastModifiedAt": "2021-01-01T00:00:00Z",
"lastModifiedByUserID": "user-12345678",
"lastModifiedByUserName": "Alice",
"orgId": "org-12345678",
"orgName": "Enterprise",
"orgUrl": "https://enterprise.com",
"serviceId": "s-12345678",
"status": "ACTIVE",
"subscriptionCount": 3,
"token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
"userId": "user-12345678",
"userName": "Alice",
"userSubscriptionRole": "root"
}
]
}

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

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

Payload

Content type

application/json

{"notifyCustomer": true,
"scheduledDate": "2020-01-01",
"sourceVersion": "1.0",
"targetVersion": "2.0",
"upgradeFilters": {"INSTANCE_IDS": ["instance-12345678",
"instance-abcdefgh"
]
}
}

Response samples

200

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": "Necessitatibus in placeat.",
"notifyCustomer": true,
"pendingCount": 3,
"plannedExecutionDate": "2020-01-01",
"productTierId": "pt-12345678",
"releasedAt": "2020-01-01T00:00:00Z",
"scheduledCount": 10,
"serviceId": "s-12345678",
"skippedCount": 0,
"sourceVersion": "1.0",
"status": "COMPLETE",
"targetVersion": "2.0",
"totalCount": 16,
"type": "Major",
"updatedAt": "2020-01-01T00:00:00Z",
"upgradePathId": "up-12345678"
}

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

200

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": "Natus laborum beatae.",
"notifyCustomer": true,
"pendingCount": 3,
"plannedExecutionDate": "2020-01-01",
"productTierId": "pt-12345678",
"releasedAt": "2020-01-01T00:00:00Z",
"scheduledCount": 10,
"serviceId": "s-12345678",
"skippedCount": 0,
"sourceVersion": "1.0",
"status": "COMPLETE",
"targetVersion": "2.0",
"totalCount": 16,
"type": "Major",
"updatedAt": "2020-01-01T00:00:00Z",
"upgradePathId": "up-12345678"
}

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

200

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": "Sunt veniam aut facilis quisquam.",
"notifyCustomer": true,
"pendingCount": 3,
"plannedExecutionDate": "2020-01-01",
"productTierId": "pt-12345678",
"releasedAt": "2020-01-01T00:00:00Z",
"scheduledCount": 10,
"serviceId": "s-12345678",
"skippedCount": 0,
"sourceVersion": "1.0",
"status": "COMPLETE",
"targetVersion": "2.0",
"totalCount": 16,
"type": "Major",
"updatedAt": "2020-01-01T00:00:00Z",
"upgradePathId": "up-12345678"
}

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=next-token

The next page token to use for pagination

Responses

Response samples

200

Content type

application/json

{"instances": [{"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"createdAt": "2020-01-01T00:00:00Z",
"instanceId": "instance-12345678",
"lifecycleStatus": "RUNNING",
"orgName": "Omnistrate",
"resourceName": "writer",
"status": "PAUSED",
"updatedAt": "2020-01-01T00:00:00Z",
"workflowID": "submit-update-instance-12345678"
},
{"cloudProviderName": "aws",
"cloudProviderRegion": "eu-west-1",
"createdAt": "2020-01-01T00:00:00Z",
"instanceId": "instance-abcdefgh",
"lifecycleStatus": "STOPPED",
"orgName": "Omnistrate",
"resourceName": "app",
"status": "FAILED",
"updatedAt": "2020-01-01T00:00:00Z",
"workflowID": "submit-update-instance-abcdefgh"
}
],
"productTierId": "pt-12345678",
"serviceId": "s-12345678",
"upgradePathId": "up-12345678"
}

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

Payload

Content type

application/json

{"action": "Fugiat vel recusandae id id laborum.",
"actionPayload": {"Dolores aliquid.": "Autem quia odio quidem tenetur.",
"Ipsam dolorum est recusandae doloremque dolorem dolor.": "Ipsa vero beatae quo quaerat labore."
}
}

Response samples

200

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": "Ullam expedita ut ullam iusto.",
"notifyCustomer": true,
"pendingCount": 3,
"plannedExecutionDate": "2020-01-01",
"productTierId": "pt-12345678",
"releasedAt": "2020-01-01T00:00:00Z",
"scheduledCount": 10,
"serviceId": "s-12345678",
"skippedCount": 0,
"sourceVersion": "1.0",
"status": "COMPLETE",
"targetVersion": "2.0",
"totalCount": 16,
"type": "Major",
"updatedAt": "2020-01-01T00:00:00Z",
"upgradePathId": "up-12345678"
}

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=next-token The next page token to use for pagination

Responses

Response samples

200

Content type

application/json

{"upgradePaths": [{"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": "Id voluptatum corporis amet enim architecto.",
"notifyCustomer": true,
"pendingCount": 3,
"plannedExecutionDate": "2020-01-01",
"productTierId": "pt-12345678",
"releasedAt": "2020-01-01T00:00:00Z",
"scheduledCount": 10,
"serviceId": "s-12345678",
"skippedCount": 0,
"sourceVersion": "1.0",
"status": "COMPLETE",
"targetVersion": "2.0",
"totalCount": 16,
"type": "Major",
"updatedAt": "2020-01-01T00:00:00Z",
"upgradePathId": "up-12345678"
},
{"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": "Id voluptatum corporis amet enim architecto.",
"notifyCustomer": true,
"pendingCount": 3,
"plannedExecutionDate": "2020-01-01",
"productTierId": "pt-12345678",
"releasedAt": "2020-01-01T00:00:00Z",
"scheduledCount": 10,
"serviceId": "s-12345678",
"skippedCount": 0,
"sourceVersion": "1.0",
"status": "COMPLETE",
"targetVersion": "2.0",
"totalCount": 16,
"type": "Major",
"updatedAt": "2020-01-01T00:00:00Z",
"upgradePathId": "up-12345678"
}
]
}

ListServicesOrchestrations inventory-api

Authorizations:

api_key_header_Authorization

query Parameters

environmentType

required

string

The environment type

Responses

Response samples

200

Content type

application/json

[{"accessServicesOrchestration": {"ServicesTopology": [{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
}
],
"createdAt": "2021-01-01T00:00:00Z",
"id": "so-12345678",
"orchestrationFailedReason": "Invalid DSL",
"resultParams": {"param1": "value1",
"param2": "value2"
},
"status": "PENDING",
"updatedAt": "2021-01-01T00:00:00Z"
}
},
{"accessServicesOrchestration": {"ServicesTopology": [{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
}
],
"createdAt": "2021-01-01T00:00:00Z",
"id": "so-12345678",
"orchestrationFailedReason": "Invalid DSL",
"resultParams": {"param1": "value1",
"param2": "value2"
},
"status": "PENDING",
"updatedAt": "2021-01-01T00:00:00Z"
}
},
{"accessServicesOrchestration": {"ServicesTopology": [{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
}
],
"createdAt": "2021-01-01T00:00:00Z",
"id": "so-12345678",
"orchestrationFailedReason": "Invalid DSL",
"resultParams": {"param1": "value1",
"param2": "value2"
},
"status": "PENDING",
"updatedAt": "2021-01-01T00:00:00Z"
}
},
{"accessServicesOrchestration": {"ServicesTopology": [{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Occaecati maiores dolore ad quisquam ipsa omnis."
}
],
"createdAt": "2021-01-01T00:00:00Z",
"id": "so-12345678",
"orchestrationFailedReason": "Invalid DSL",
"resultParams": {"param1": "value1",
"param2": "value2"
},
"status": "PENDING",
"updatedAt": "2021-01-01T00:00:00Z"
}
}
]

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

Payload

Content type

application/json

{"orchestrationCreateDSL": "Vero quas quaerat iure rem et repudiandae."
}

Response samples

202

Content type

application/json

{"id": "so-12345678"
}

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

200

Content type

application/json

{"accessServicesOrchestration": {"ServicesTopology": [{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Voluptatum dolor."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Voluptatum dolor."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Voluptatum dolor."
},
{"dependsOnDeployment": ["instanceDeploymentAlias1",
"instanceDeploymentAlias2"
],
"failedReason": "Invalid inputs",
"instanceDeploymentAlias": "instanceDeploymentAlias",
"instanceId": "i-12345678",
"serviceId": "s-12345678",
"status": "PENDING",
"statusMessage": "Creating deployment",
"subscriptionId": "Voluptatum dolor."
}
],
"createdAt": "2021-01-01T00:00:00Z",
"id": "so-12345678",
"orchestrationFailedReason": "Invalid DSL",
"resultParams": {"param1": "value1",
"param2": "value2"
},
"status": "PENDING",
"updatedAt": "2021-01-01T00:00:00Z"
}
}

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

Payload

Content type

application/json

{"orchestrationModifyDSL": "At consequatur quidem facilis in natus molestiae."
}

CreateConsumptionUser inventory-api

Authorizations:

api_key_header_Authorization

Request Body schema: application/json
required

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

Payload

Content type

application/json

{"companyUrl": "https://mywebsite.com",
"email": "abc@gmail.com",
"enableAutoVerification": true,
"legalCompanyName": "mywebsite",
"name": "John Doe",
"password": "password"
}

Response samples

200

Content type

application/json

"Quo rerum officiis doloremque."

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

200

Content type

application/json

{"createdAt": "2021-01-01T00:00:00Z",
"email": "alice@enterprise.com",
"enabled": true,
"lastModifiedAt": "2021-01-01T00:00:00Z",
"lastModifiedByUserID": "user-12345678",
"lastModifiedByUserName": "Alice",
"orgId": "org-12345678",
"orgName": "Enterprise",
"orgUrl": "https://enterprise.com",
"status": "ACTIVE",
"subscriptions": [{"cloudProviderNames": ["aws",
"gcp"
],
"defaultSubscription": true,
"email": "abc@gmail.com",
"instanceCount": 3,
"name": "John Dae",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"roleType": "reader",
"serviceEnvironmentId": "se-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Qui dolorem nemo velit harum voluptatem.",
"serviceName": "MySQL multi-writer service",
"subscriptionDate": "2019-01-01T00:00:00Z",
"subscriptionId": "sub-abcd1234",
"subscriptionOwnerName": "John Doe",
"userId": "[]user-abcd1234"
},
{"cloudProviderNames": ["aws",
"gcp"
],
"defaultSubscription": true,
"email": "abc@gmail.com",
"instanceCount": 3,
"name": "John Dae",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"roleType": "reader",
"serviceEnvironmentId": "se-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Qui dolorem nemo velit harum voluptatem.",
"serviceName": "MySQL multi-writer service",
"subscriptionDate": "2019-01-01T00:00:00Z",
"subscriptionId": "sub-abcd1234",
"subscriptionOwnerName": "John Doe",
"userId": "[]user-abcd1234"
},
{"cloudProviderNames": ["aws",
"gcp"
],
"defaultSubscription": true,
"email": "abc@gmail.com",
"instanceCount": 3,
"name": "John Dae",
"productTierId": "pt-12345678",
"productTierName": "Omnistrate Multi Tenancy",
"roleType": "reader",
"serviceEnvironmentId": "se-12345678",
"serviceId": "s-12345678",
"serviceLogoURL": "Qui dolorem nemo velit harum voluptatem.",
"serviceName": "MySQL multi-writer service",
"subscriptionDate": "2019-01-01T00:00:00Z",
"subscriptionId": "sub-abcd1234",
"subscriptionOwnerName": "John Doe",
"userId": "[]user-abcd1234"
}
],
"token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
"userId": "user-12345678",
"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

ListAllUsers inventory-api

Authorizations:

api_key_header_Authorization

query Parameters

serviceId

string

Example: serviceId=s-12345678

The service ID of the users

Responses

Response samples

200

Content type

application/json

{"nextPageToken": "next-token",
"serviceId": "s-12345678",
"users": [{"createdAt": "2021-01-01T00:00:00Z",
"email": "alice@enterprise.com",
"enabled": true,
"instanceCount": 3,
"lastModifiedAt": "2021-01-01T00:00:00Z",
"lastModifiedByUserID": "user-12345678",
"lastModifiedByUserName": "Alice",
"orgId": "org-12345678",
"orgName": "Enterprise",
"orgUrl": "https://enterprise.com",
"status": "ACTIVE",
"subscriptionCount": 3,
"token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
"userId": "user-12345678",
"userName": "Alice"
},
{"createdAt": "2021-01-01T00:00:00Z",
"email": "alice@enterprise.com",
"enabled": true,
"instanceCount": 3,
"lastModifiedAt": "2021-01-01T00:00:00Z",
"lastModifiedByUserID": "user-12345678",
"lastModifiedByUserName": "Alice",
"orgId": "org-12345678",
"orgName": "Enterprise",
"orgUrl": "https://enterprise.com",
"status": "ACTIVE",
"subscriptionCount": 3,
"token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6",
"userId": "user-12345678",
"userName": "Alice"
}
]
}

hostcluster-api

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

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

Responses

Response samples

200

Content type

application/json

{"hostClusters": [{"accountConfigId": "ac-12345678",
"description": "My Host Cluster",
"helmPackages": [{"firstDeployed": "2021-01-01T00:00:00Z",
"lastDeployed": "2021-01-01T00:00:00Z",
"name": "my-helm-package",
"namespace": "my-namespace",
"repository": "https://my-helm-repo.com",
"status": "deployed",
"values": {"key1": "value1",
"key2": "value2"
},
"version": "1.0.0"
}
],
"id": "hc-12345678",
"key": "my-host-cluster",
"kubernetesDashboardEndpoint": "https://my-k8s-dashboard.com",
"regionId": "region-12345678",
"status": "READY",
"type": "Kubernetes"
}
],
"token": "w"
}

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

200

Content type

application/json

{"events": [{"eventID": "e-123456",
"eventPayload": {"eventType": "CustomerSignUp",
"token": "123456"
},
"eventType": "InviteUser",
"orgID": "o-123456",
"orgName": "Acme Corp",
"orgURL": "https://acme.com",
"priority": "Critical",
"time": "2023-01-10T00:00:00Z",
"userEmail": "user@example.com",
"userID": "user-123456",
"userName": "user"
},
{"eventID": "e-123456",
"eventPayload": {"eventType": "CustomerSignUp",
"token": "123456"
},
"eventType": "InviteUser",
"orgID": "o-123456",
"orgName": "Acme Corp",
"orgURL": "https://acme.com",
"priority": "Critical",
"time": "2023-01-10T00:00:00Z",
"userEmail": "user@example.com",
"userID": "user-123456",
"userName": "user"
}
]
}

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

serviceID	string Example: serviceID=s-123456 The service ID to list events for
environmentType	string Example: environmentType=PROD\|PRIVATE\|CANARY\|STAGING\|QA\|DEV The type of service environment
eventSourceTypes	Array of strings Example: eventSourceTypes=Reiciendis necessitatibus dignissimos quas quam voluptas vel.&eventSourceTypes=Et quo voluptatem saepe et deleniti quia. The event types to filter by
instanceID	string Example: instanceID=instance-12345678 The instance ID to list events for
productTierID	string Example: productTierID=Eum officiis et. ID of a Product Tier
nextPageToken	string Example: nextPageToken=token The next token to use for pagination
pageSize	integer <int64> Example: pageSize=10 The number of events to return per page
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

200

Content type

application/json

{"events": [{"environmentId": "Omnis nemo dolorem autem ea aut.",
"eventSource": "Customer, Infra or Maintenance",
"id": "Aliquam eos aperiam porro.",
"instanceId": "Praesentium magnam.",
"message": "instance-abcd1234 created",
"orgId": "org-12345678",
"orgName": "Acme Corporation",
"planVersion": "v1.0",
"productTierId": "Fugiat distinctio libero est modi dolores ut.",
"resourceName": "Eligendi debitis.",
"serviceId": "Excepturi dignissimos expedita qui repudiandae delectus quisquam.",
"serviceName": "mysql",
"servicePlanName": "Basic Plan",
"time": "Sed tempora delectus et ut aut.",
"userId": "user-12345678",
"userName": "John Doe",
"workflowFailures": [{"eventTime": "2020-01-01T00:00:00Z",
"message": "Bootstrap failed for reason X"
},
{"eventTime": "2020-01-01T00:01:00Z",
"message": "Compute failed for reason Y"
}
],
"workflowId": "workflow-12345678"
},
{"environmentId": "Omnis nemo dolorem autem ea aut.",
"eventSource": "Customer, Infra or Maintenance",
"id": "Aliquam eos aperiam porro.",
"instanceId": "Praesentium magnam.",
"message": "instance-abcd1234 created",
"orgId": "org-12345678",
"orgName": "Acme Corporation",
"planVersion": "v1.0",
"productTierId": "Fugiat distinctio libero est modi dolores ut.",
"resourceName": "Eligendi debitis.",
"serviceId": "Excepturi dignissimos expedita qui repudiandae delectus quisquam.",
"serviceName": "mysql",
"servicePlanName": "Basic Plan",
"time": "Sed tempora delectus et ut aut.",
"userId": "user-12345678",
"userName": "John Doe",
"workflowFailures": [{"eventTime": "2020-01-01T00:00:00Z",
"message": "Bootstrap failed for reason X"
},
{"eventTime": "2020-01-01T00:01:00Z",
"message": "Compute failed for reason Y"
}
],
"workflowId": "workflow-12345678"
},
{"environmentId": "Omnis nemo dolorem autem ea aut.",
"eventSource": "Customer, Infra or Maintenance",
"id": "Aliquam eos aperiam porro.",
"instanceId": "Praesentium magnam.",
"message": "instance-abcd1234 created",
"orgId": "org-12345678",
"orgName": "Acme Corporation",
"planVersion": "v1.0",
"productTierId": "Fugiat distinctio libero est modi dolores ut.",
"resourceName": "Eligendi debitis.",
"serviceId": "Excepturi dignissimos expedita qui repudiandae delectus quisquam.",
"serviceName": "mysql",
"servicePlanName": "Basic Plan",
"time": "Sed tempora delectus et ut aut.",
"userId": "user-12345678",
"userName": "John Doe",
"workflowFailures": [{"eventTime": "2020-01-01T00:00:00Z",
"message": "Bootstrap failed for reason X"
},
{"eventTime": "2020-01-01T00:01:00Z",
"message": "Compute failed for reason Y"
}
],
"workflowId": "workflow-12345678"
},
{"environmentId": "Omnis nemo dolorem autem ea aut.",
"eventSource": "Customer, Infra or Maintenance",
"id": "Aliquam eos aperiam porro.",
"instanceId": "Praesentium magnam.",
"message": "instance-abcd1234 created",
"orgId": "org-12345678",
"orgName": "Acme Corporation",
"planVersion": "v1.0",
"productTierId": "Fugiat distinctio libero est modi dolores ut.",
"resourceName": "Eligendi debitis.",
"serviceId": "Excepturi dignissimos expedita qui repudiandae delectus quisquam.",
"serviceName": "mysql",
"servicePlanName": "Basic Plan",
"time": "Sed tempora delectus et ut aut.",
"userId": "user-12345678",
"userName": "John Doe",
"workflowFailures": [{"eventTime": "2020-01-01T00:00:00Z",
"message": "Bootstrap failed for reason X"
},
{"eventTime": "2020-01-01T00:01:00Z",
"message": "Compute failed for reason Y"
}
],
"workflowId": "workflow-12345678"
}
],
"ids": ["event-12345678"
],
"nextPageToken": "Quia est maiores atque maxime ut."
}

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

200

Content type

application/json

{"cloudProvider": "aws",
"hostClusterID": "hc-12345678",
"instanceHealth": {"Iusto explicabo labore est non.": {"instanceID": "instance-12345678",
"lifeCycleStatus": "RUNNING",
"resourcesHealth": {"Repellat iure alias aperiam aut.": {"nodesHealth": {"Quis sed.": {"availabilityZone": "us-east-2a",
"connectivityStatus": "HEALTHY",
"diskHealth": "HEALTHY",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"events": ["event-1",
"event-2"
],
"integrationsHealth": {"CustomerObservabilityHealth": "HEALTHY",
"InternalObservabilityHealth": "HEALTHY"
},
"loadStatus": "LOAD_NORMAL",
"nodeHealth": "HEALTHY",
"nodeName": "postgres-0",
"ports": [80,
443
],
"processHealth": "HEALTHY",
"processLiveness": "HEALTHY",
"recentLogs": "Log message",
"status": "HEALTHY"
},
"Velit doloribus hic explicabo voluptas.": {"availabilityZone": "us-east-2a",
"connectivityStatus": "HEALTHY",
"diskHealth": "HEALTHY",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"events": ["event-1",
"event-2"
],
"integrationsHealth": {"CustomerObservabilityHealth": "HEALTHY",
"InternalObservabilityHealth": "HEALTHY"
},
"loadStatus": "LOAD_NORMAL",
"nodeHealth": "HEALTHY",
"nodeName": "postgres-0",
"ports": [80,
443
],
"processHealth": "HEALTHY",
"processLiveness": "HEALTHY",
"recentLogs": "Log message",
"status": "HEALTHY"
},
"Voluptates optio nisi mollitia similique hic esse.": {"availabilityZone": "us-east-2a",
"connectivityStatus": "HEALTHY",
"diskHealth": "HEALTHY",
"endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
"events": ["event-1",
"event-2"
],
"integrationsHealth": {"CustomerObservabilityHealth": "HEALTHY",
"InternalObservabilityHealth": "HEALTHY"
},
"loadStatus": "LOAD_NORMAL",
"nodeHealth": "HEALTHY",
"nodeName": "postgres-0",
"ports": [80,
443
],
"processHealth": "HEALTHY",
"processLiveness": "HEALTHY",
"recentLogs": "Log message",
"status": "HEALTHY"
}
},
"resourceID": "resource-12345678",
"resourceKey": "primary",
"resourceType": "Kustomize",
"status": "HEALTHY"
}
},
"status": "HEALTHY"
}
},
"regionCode": "us-west-1",
"serviceEnvironmentName": "prod",
"serviceName": "mysql"
}

ListEvents operations-api

Authorizations:

api_key_header_Authorization

query Parameters

environmentType	string Example: environmentType=PROD\|PRIVATE\|CANARY\|STAGING\|QA\|DEV The type of service environment
eventTypes	Array of strings Example: eventTypes=UnhealthyInstance\|FailedDeployment\|ScaleOut\|UserSignUp\|UserSubscription&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
nextPageToken	string Example: nextPageToken=token The next token to use for pagination
pageSize	integer <int64> Example: pageSize=10 The number of events to return per page
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=Eum officiis et. ID of a Product Tier

Responses

Response samples

200

Content type

application/json

{"events": [{"alertType": "Alarm",
"eventCategory": "InstanceEvent",
"eventID": "e-123456",
"eventPayload": {"Qui maxime nobis facere.": "Omnis rerum voluptatem voluptas."
},
"eventType": "UnhealthyInstance",
"expiryTime": "2023-01-10T00:00:00Z",
"instanceID": "instance-12345678",
"planVersion": "v1.0",
"priority": "Critical",
"resourceName": "Resource-123",
"scope": "ServiceProvider",
"serviceEnvironmentID": "se-123456",
"serviceID": "s-123456",
"serviceName": "Service-123",
"servicePlanName": "Basic Plan",
"time": "2023-01-10T00:00:00Z"
},
{"alertType": "Alarm",
"eventCategory": "InstanceEvent",
"eventID": "e-123456",
"eventPayload": {"Qui maxime nobis facere.": "Omnis rerum voluptatem voluptas."
},
"eventType": "UnhealthyInstance",
"expiryTime": "2023-01-10T00:00:00Z",
"instanceID": "instance-12345678",
"planVersion": "v1.0",
"priority": "Critical",
"resourceName": "Resource-123",
"scope": "ServiceProvider",
"serviceEnvironmentID": "se-123456",
"serviceID": "s-123456",
"serviceName": "Service-123",
"servicePlanName": "Basic Plan",
"time": "2023-01-10T00:00:00Z"
},
{"alertType": "Alarm",
"eventCategory": "InstanceEvent",
"eventID": "e-123456",
"eventPayload": {"Qui maxime nobis facere.": "Omnis rerum voluptatem voluptas."
},
"eventType": "UnhealthyInstance",
"expiryTime": "2023-01-10T00:00:00Z",
"instanceID": "instance-12345678",
"planVersion": "v1.0",
"priority": "Critical",
"resourceName": "Resource-123",
"scope": "ServiceProvider",
"serviceEnvironmentID": "se-123456",
"serviceID": "s-123456",
"serviceName": "Service-123",
"servicePlanName": "Basic Plan",
"time": "2023-01-10T00:00:00Z"
},
{"alertType": "Alarm",
"eventCategory": "InstanceEvent",
"eventID": "e-123456",
"eventPayload": {"Qui maxime nobis facere.": "Omnis rerum voluptatem voluptas."
},
"eventType": "UnhealthyInstance",
"expiryTime": "2023-01-10T00:00:00Z",
"instanceID": "instance-12345678",
"planVersion": "v1.0",
"priority": "Critical",
"resourceName": "Resource-123",
"scope": "ServiceProvider",
"serviceEnvironmentID": "se-123456",
"serviceID": "s-123456",
"serviceName": "Service-123",
"servicePlanName": "Basic Plan",
"time": "2023-01-10T00:00:00Z"
}
],
"eventsSummary": {"eventsSummary": {"FailedDeployment": 1,
"UnhealthyInstance": 2
}
},
"nextPageToken": "Soluta accusamus doloribus."
}

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

200

Content type

application/json

{"cloudProviderHealthSummary": {"Exercitationem et modi non in quia laboriosam.": {"cloudProvider": "aws",
"deployingInstances": 4862778753690201000,
"healthyInstances": 2966080545266412500,
"message": "Cloud provider is healthy",
"regionalHealthSummary": {"Et minima enim suscipit eum enim.": {"deployingInstances": 7036097413366286000,
"deploymentCellHealthSummary": {"Cum temporibus quis nostrum in.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
},
"Eveniet expedita.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
},
"Itaque fugiat sunt neque dolor.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
}
},
"healthyInstances": 4345329955544206000,
"message": "Region is healthy",
"region": "us-east-1",
"status": "Healthy",
"totalInstances": 8401579683997309000,
"unhealthyInstances": 6447957384705101000,
"unknownInstances": 6157897990613373000
},
"Tenetur dolor minima sed ad illum incidunt.": {"deployingInstances": 7036097413366286000,
"deploymentCellHealthSummary": {"Cum temporibus quis nostrum in.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
},
"Eveniet expedita.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
},
"Itaque fugiat sunt neque dolor.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
}
},
"healthyInstances": 4345329955544206000,
"message": "Region is healthy",
"region": "us-east-1",
"status": "Healthy",
"totalInstances": 8401579683997309000,
"unhealthyInstances": 6447957384705101000,
"unknownInstances": 6157897990613373000
},
"Veniam rerum cumque.": {"deployingInstances": 7036097413366286000,
"deploymentCellHealthSummary": {"Cum temporibus quis nostrum in.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
},
"Eveniet expedita.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
},
"Itaque fugiat sunt neque dolor.": {"deployingInstances": 2814615883702224000,
"healthyInstances": 7228924758875021000,
"hostClusterID": "hc-12345678",
"message": "Cell is healthy",
"status": "Healthy",
"totalInstances": 709239058824452000,
"unhealthyInstances": 6013490457300057000,
"unknownInstances": 3163003175743578600
}
},
"healthyInstances": 4345329955544206000,
"message": "Region is healthy",
"region": "us-east-1",
"status": "Healthy",
"totalInstances": 8401579683997309000,
"unhealthyInstances": 6447957384705101000,
"unknownInstances": 6157897990613373000
}
},
"status": "Healthy",
"totalInstances": 1436607539401319200,
"unhealthyInstances": 5472777429959506000,
"unknownInstances": 8597899285561137000
}
},
"deployingInstances": 708052589773717600,
"healthyInstances": 8879520192624745000,
"message": "Service is healthy",
"serviceEnvironmentID": "se-123456",
"serviceID": "s-123456",
"status": "Healthy",
"totalInstances": 480038683413140700,
"unhealthyInstances": 9032116514889142000,
"unknownInstances": 7312250003370237000
}

webhooks-api

ReceiveWebhook webhooks-api

path Parameters

id

required

string

Example: Laborum veniam quos voluptate ea non sint.

The unique id per producer.

Request Body schema: application/json
required

The event data

string

The event data

Responses

Request samples

Payload

Content type

application/json

"Similique fuga."

fleet-features-api

DisableFleetFeature fleet-features-api

Authorizations:

api_key_header_Authorization

Request Body schema: application/json
required

feature

string

The feature to disable.

Responses

Request samples

Payload

Content type

application/json

{"feature": "Unde asperiores hic vel consequatur et eum."
}

EnableFleetFeature fleet-features-api

Authorizations:

api_key_header_Authorization

Request Body schema: application/json
required

feature

string

The feature to enable.

Responses

Request samples

Payload

Content type

application/json

{"feature": "Nemo voluptas sed architecto explicabo."
}

DescribeFleetFeature fleet-features-api

Authorizations:

api_key_header_Authorization

path Parameters

feature

required

string

Example: CUSTOMER_BILLING

The feature to describe.

Responses

Response samples

200

Content type

application/json

{"feature": "Quia adipisci ut suscipit voluptates modi.",
"featureConfig": {"stripe_customer_id": "cus_123456789"
},
"status": "pending"
}

ListFleetFeatures fleet-features-api

Authorizations:

api_key_header_Authorization

Responses

Response samples

200

Content type

application/json

{"features": [{"feature": "Doloribus voluptas qui.",
"featureConfig": {"stripe_customer_id": "cus_123456789"
},
"status": "pending"
},
{"feature": "Doloribus voluptas qui.",
"featureConfig": {"stripe_customer_id": "cus_123456789"
},
"status": "pending"
},
{"feature": "Doloribus voluptas qui.",
"featureConfig": {"stripe_customer_id": "cus_123456789"
},
"status": "pending"
}
]
}

notifications-api

ListNotificationChannels notifications-api

Authorizations:

api_key_header_Authorization

Responses

Response samples

200

Content type

application/json

{"channels": [{"channelType": "EMAIL",
"email": {"to": "notify@example.com"
},
"id": "channel-12345678"
},
{"channelType": "SLACK",
"id": "channel-87654321",
"slack": {"webhookUrl": "https://hooks.slack.com/services/..."
}
}
]
}

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

Payload

Content type

application/json

{"email": {"to": "notify@example.com"
},
"name": "My Channel",
"pagerDuty": {"APIKey": "e93facc47f2d4b2b88272b3a647afe7d-fictional-integration-key"
},
"slack": {"webhookUrl": "https://hooks.slack.com/services/..."
},
"subscription": {"alertTypes": ["Alarm",
"Notification"
],
"environmentTypes": ["PROD",
"PRIVATE",
"CANARY"
],
"eventCategories": ["InstanceEvent",
"ServiceEvent"
],
"eventPriorities": ["Critical",
"High"
],
"eventTypes": ["UnhealthyInstance",
"UserSignUp"
]
},
"webhook": {"method": "POST",
"url": "https://example.com/notify"
}
}

Response samples

200

Content type

application/json

"Aliquam id itaque voluptatem voluptatem."

DeleteNotificationChannel notifications-api

Authorizations:

api_key_header_Authorization

path Parameters

id

required

string

Example: channel-12345678

Unique identifier of the channel

Responses

DescribeNotificationChannel notifications-api

Authorizations:

api_key_header_Authorization

path Parameters

id

required

string

Example: channel-12345678

Unique identifier of the channel

Responses

Response samples

200

Content type

application/json

{"channelType": "EMAIL",
"email": {"to": "notify@example.com"
},
"id": "channel-12345678",
"name": "My Channel",
"pagerDuty": {"integrationKey": "e93facc47f2d4b2b88272b3a647afe7d-fictional-integration-key"
},
"slack": {"webhookUrl": "https://hooks.slack.com/services/..."
},
"subscription": {"alertTypes": ["Alarm",
"Notification"
],
"environmentTypes": ["PROD",
"PRIVATE",
"CANARY"
],
"eventCategories": ["InstanceEvent",
"ServiceEvent"
],
"eventPriorities": ["Critical",
"High"
],
"eventTypes": ["UnhealthyInstance",
"UserSignUp"
]
},
"webhook": {"method": "POST",
"url": "https://example.com/notify"
}
}

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

Payload

Content type

application/json

{"email": {"to": "notify@example.com"
},
"name": "My Channel",
"pagerDuty": {"APIKey": "e93facc47f2d4b2b88272b3a647afe7d-fictional-integration-key"
},
"slack": {"webhookUrl": "https://hooks.slack.com/services/..."
},
"subscription": {"alertTypes": ["Alarm",
"Notification"
],
"environmentTypes": ["PROD",
"PRIVATE",
"CANARY"
],
"eventCategories": ["InstanceEvent",
"ServiceEvent"
],
"eventPriorities": ["Critical",
"High"
],
"eventTypes": ["UnhealthyInstance",
"UserSignUp"
]
},
"webhook": {"method": "POST",
"url": "https://example.com/notify"
}
}

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

200

Content type

application/json

{"onboardings": [{"id": "onboarding-1234567890",
"isCompleted": true,
"name": "My Onboarding",
"orgId": "org-1234567890",
"serviceId": "service-1234567890",
"stages": [{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
}
],
"userId": "user-1234567890"
},
{"id": "onboarding-1234567890",
"isCompleted": true,
"name": "My Onboarding",
"orgId": "org-1234567890",
"serviceId": "service-1234567890",
"stages": [{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
}
],
"userId": "user-1234567890"
}
]
}

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

Payload

Content type

application/json

{"name": "Corrupti velit dolores est placeat ut."
}

Response samples

200

Content type

application/json

"Quo omnis totam tempora pariatur et facilis."

ListCustomerOnboardingStages customer-onboardings-api

Authorizations:

api_key_header_Authorization

Responses

Response samples

200

Content type

application/json

{"stages": [{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
}
]
}

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

200

Content type

application/json

{"id": "onboarding-1234567890",
"isCompleted": true,
"name": "My Onboarding",
"orgId": "org-1234567890",
"serviceId": "service-1234567890",
"stages": [{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
},
{"name": "ConfigureAccounts|BuildSaaS|LaunchSaaS",
"status": "NOT_STARTED|COMPLETE|SKIPPED"
}
],
"userId": "user-1234567890"
}

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

Payload

Content type

application/json

{"serviceId": "service-1234567890",
"stage": {"name": "ConfigureAccounts",
"status": "Skipped"
}
}

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

200

Content type

application/json

{"helmPackageInstallations": [{"helmPackage": {"chartName": "my-chart",
"chartRepoName": "my-repo",
"chartRepoUrl": "https://my-repo.com",
"chartValues": {"key1": "value1",
"key2": 3,
"key3": {"key4": "value4"
}
},
"chartVersion": "1.0.0",
"namespace": "default"
},
"hostClusterID": "hc-12345678",
"status": "unknown|deployed|uninstalled|superseded|failed|uninstalling|pending-install|pending-upgrade|pending-rollback"
},
{"helmPackage": {"chartName": "my-chart",
"chartRepoName": "my-repo",
"chartRepoUrl": "https://my-repo.com",
"chartValues": {"key1": "value1",
"key2": 3,
"key3": {"key4": "value4"
}
},
"chartVersion": "1.0.0",
"namespace": "default"
},
"hostClusterID": "hc-12345678",
"status": "unknown|deployed|uninstalled|superseded|failed|uninstalling|pending-install|pending-upgrade|pending-rollback"
},
{"helmPackage": {"chartName": "my-chart",
"chartRepoName": "my-repo",
"chartRepoUrl": "https://my-repo.com",
"chartValues": {"key1": "value1",
"key2": 3,
"key3": {"key4": "value4"
}
},
"chartVersion": "1.0.0",
"namespace": "default"
},
"hostClusterID": "hc-12345678",
"status": "unknown|deployed|uninstalled|superseded|failed|uninstalling|pending-install|pending-upgrade|pending-rollback"
}
]
}

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 that custom network should be created in
cloudProviderRegion	string Example: cloudProviderRegion=us-east-1 The region of the cloud provider that the network should be created in
customNetworksOnly	boolean Example: customNetworksOnly=false Flag indicating whether to return only custom networks, or to include default and imported networks as well

Responses

Response samples

200

Content type

application/json

{"customNetworks": [{"cidr": "10.0.0.0/16",
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"id": "n-12345678",
"name": "Prod us-east-1",
"networkDefinitionType": "Custom",
"networkFeaturesConfiguration": {"isPrivateLinkEnabled": true
},
"networkInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
}
],
"owningOrgID": "org-12345678",
"owningOrgName": "my-customer",
"owningUserID": "user-12345678",
"owningUserName": "Jane Doe"
},
{"cidr": "10.0.0.0/16",
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"id": "n-12345678",
"name": "Prod us-east-1",
"networkDefinitionType": "Custom",
"networkFeaturesConfiguration": {"isPrivateLinkEnabled": true
},
"networkInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
}
],
"owningOrgID": "org-12345678",
"owningOrgName": "my-customer",
"owningUserID": "user-12345678",
"owningUserName": "Jane Doe"
},
{"cidr": "10.0.0.0/16",
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"id": "n-12345678",
"name": "Prod us-east-1",
"networkDefinitionType": "Custom",
"networkFeaturesConfiguration": {"isPrivateLinkEnabled": true
},
"networkInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
}
],
"owningOrgID": "org-12345678",
"owningOrgName": "my-customer",
"owningUserID": "user-12345678",
"owningUserName": "Jane Doe"
},
{"cidr": "10.0.0.0/16",
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"id": "n-12345678",
"name": "Prod us-east-1",
"networkDefinitionType": "Custom",
"networkFeaturesConfiguration": {"isPrivateLinkEnabled": true
},
"networkInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
}
],
"owningOrgID": "org-12345678",
"owningOrgName": "my-customer",
"owningUserID": "user-12345678",
"owningUserName": "Jane Doe"
}
]
}

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

Payload

Content type

application/json

{"cidr": "10.0.0.0/16",
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"name": "Prod us-east-1",
"networkFeaturesConfiguration": {"isPrivateLinkEnabled": false
}
}

Response samples

200

Content type

application/json

{"cidr": "10.0.0.0/16",
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"id": "n-12345678",
"name": "Prod us-east-1",
"networkDefinitionType": "Custom",
"networkFeaturesConfiguration": {"isPrivateLinkEnabled": true
},
"networkInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
}
],
"owningOrgID": "org-12345678",
"owningOrgName": "my-customer",
"owningUserID": "user-12345678",
"owningUserName": "Jane Doe"
}

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

200

Content type

application/json

{"cidr": "10.0.0.0/16",
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"id": "n-12345678",
"name": "Prod us-east-1",
"networkDefinitionType": "Custom",
"networkFeaturesConfiguration": {"isPrivateLinkEnabled": true
},
"networkInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
}
],
"owningOrgID": "org-12345678",
"owningOrgName": "my-customer",
"owningUserID": "user-12345678",
"owningUserName": "Jane Doe"
}

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

Payload

Content type

application/json

{"name": "Dev us-east-1"
}

Response samples

200

Content type

application/json

{"cidr": "10.0.0.0/16",
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"id": "n-12345678",
"name": "Prod us-east-1",
"networkDefinitionType": "Custom",
"networkFeaturesConfiguration": {"isPrivateLinkEnabled": true
},
"networkInstances": [{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
},
{"awsAccountID": "123456789012",
"azureSubscriptionID": "12345678-1234-1234-1234-123456789012",
"azureTenantID": "12345678-1234-1234-1234-123456789012",
"cloudProviderNativeNetworkId": "vpc-12345678",
"gcpProjectID": "my-project",
"gcpProjectNumber": "123456789012",
"hostClusterID": "hc-12345678"
}
],
"owningOrgID": "org-12345678",
"owningOrgName": "my-customer",
"owningUserID": "user-12345678",
"owningUserName": "Jane Doe"
}

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

Responses

Response samples

200

Content type

application/json

{"invoices": [{"currency": "USD",
"customerId": "org-1234568",
"customerName": "Acme Corp",
"dueDate": "2023-10-01T00:00:00Z",
"id": "invoice-1234568",
"invoiceDate": "2023-10-01T00:00:00Z",
"invoiceUrl": "https://dashboard.stripe.com/invoices/in_1R9aJ8G10a5MrQfCjUX3dstN",
"paymentTerms": "Net 30",
"status": "open",
"taxAmount": 10,
"totalAmount": 110,
"totalAmountWithoutTax": 100
},
{"currency": "USD",
"customerId": "org-1234568",
"customerName": "Acme Corp",
"dueDate": "2023-10-01T00:00:00Z",
"id": "invoice-1234568",
"invoiceDate": "2023-10-01T00:00:00Z",
"invoiceUrl": "https://dashboard.stripe.com/invoices/in_1R9aJ8G10a5MrQfCjUX3dstN",
"paymentTerms": "Net 30",
"status": "open",
"taxAmount": 10,
"totalAmount": 110,
"totalAmountWithoutTax": 100
},
{"currency": "USD",
"customerId": "org-1234568",
"customerName": "Acme Corp",
"dueDate": "2023-10-01T00:00:00Z",
"id": "invoice-1234568",
"invoiceDate": "2023-10-01T00:00:00Z",
"invoiceUrl": "https://dashboard.stripe.com/invoices/in_1R9aJ8G10a5MrQfCjUX3dstN",
"paymentTerms": "Net 30",
"status": "open",
"taxAmount": 10,
"totalAmount": 110,
"totalAmountWithoutTax": 100
},
{"currency": "USD",
"customerId": "org-1234568",
"customerName": "Acme Corp",
"dueDate": "2023-10-01T00:00:00Z",
"id": "invoice-1234568",
"invoiceDate": "2023-10-01T00:00:00Z",
"invoiceUrl": "https://dashboard.stripe.com/invoices/in_1R9aJ8G10a5MrQfCjUX3dstN",
"paymentTerms": "Net 30",
"status": "open",
"taxAmount": 10,
"totalAmount": 110,
"totalAmountWithoutTax": 100
}
]
}

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

cost-api

DescribeCloudProviderCost cost-api

Authorizations:

query Parameters

Responses

Response samples

DescribeDeploymentCellCost cost-api

Authorizations:

query Parameters

Responses

Response samples

DescribeRegionCost cost-api

Authorizations:

query Parameters

Responses

Response samples

DescribeUserCost cost-api

Authorizations:

query Parameters

Responses

Response samples

fleet-workflows-api

ListServiceWorkflows fleet-workflows-api

Authorizations:

path Parameters

query Parameters

Responses

Response samples

DescribeServiceWorkflowSummary fleet-workflows-api

Authorizations:

path Parameters

Responses

Response samples

TerminateServiceWorkflow fleet-workflows-api

Authorizations:

path Parameters

Responses

Response samples

DescribeServiceWorkflow fleet-workflows-api

Authorizations:

path Parameters

Responses

Response samples

UpdateServiceWorkflow fleet-workflows-api

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

GetWorkflowEvents fleet-workflows-api

Authorizations:

path Parameters

Responses

Response samples

inventory-api

ListAllOrganizations inventory-api

Authorizations:

query Parameters

Responses

Response samples

DeleteProxyResourceInstance inventory-api

Authorizations:

path Parameters

Responses

CreateProxyResourceInstance inventory-api

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

CreateResourceInstance inventory-api

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required