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

Download OpenAPI specification:Download

REST API for Omnistrate Fleet

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": "Sed vero.",
"serviceId": "s-12345678",
"workflows": [{"ResourceCount": 3682878071606485500,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"orgName": "my-org",
"parentId": "Nemo dolore iure nobis dolor similique.",
"planType": "my-plan",
"servicePlanName": "my-product-tier-plan",
"startTime": "2020-01-01T00:00:00Z",
"status": "IN_PROGRESS"
},
{"ResourceCount": 3682878071606485500,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"orgName": "my-org",
"parentId": "Nemo dolore iure nobis dolor similique.",
"planType": "my-plan",
"servicePlanName": "my-product-tier-plan",
"startTime": "2020-01-01T00:00:00Z",
"status": "IN_PROGRESS"
},
{"ResourceCount": 3682878071606485500,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"orgName": "my-org",
"parentId": "Nemo dolore iure nobis dolor similique.",
"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": 2344543989761238000,
"CompletedWorkflowCount": 5885159775195930000,
"FailedWorkflowCount": 7800971028578282000,
"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": 4608440074873916400,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"orgName": "my-org",
"parentId": "Asperiores tempora inventore rerum dolorem totam.",
"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"
}
],
"Workflow": {"ResourceCount": 3682878071606485500,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"orgName": "my-org",
"parentId": "Nemo dolore iure nobis dolor similique.",
"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": 249177989269012740,
"UpdatedBy": "Anonymous",
"UpdatedReason": "Customer requested termination.",
"WorkflowType": "Service deployment.",
"awsAccountID": "123456789012",
"cloudProvider": "aws",
"endTime": "2020-01-01T00:01:00Z",
"gcpProjectID": "my-project",
"id": "submit-create-instance-plan-instance-50h74sj46",
"orgName": "my-org",
"parentId": "Animi amet culpa et.",
"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.

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": "Omnis mollitia dolorem labore."
}

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
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",
"network_type": "PUBLIC|PRIVATE_VPC_PEERING|PRIVATE_LINK|INTERNAL",
"productTierVersion": "1.0",
"region": "us-east-1",
"requestParams": {"param1": "value1",
"param2": "value2"
},
"subscriptionId": "sub-12345678"
}

Response samples

202

Content type

application/json

{"id": "Quo laborum neque quas delectus."
}

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

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",
"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",
"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",
"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",
"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",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"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
],
"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": "Tenetur corrupti corrupti deleniti nulla.",
"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",
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC",
"productTierFeatures": {"BILLING": {"enabled": false
},
"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",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234"
},
"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",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"managedResourceType": "PortsBasedProxy",
"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
}
},
{"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
}
},
{"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": "Et consequatur.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"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

requestParams	any The request parameters
resourceId required	string The resource ID.

Responses

Request samples

Payload

Content type

application/json

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

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"
]
},
{"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",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"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
],
"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": "Tenetur corrupti corrupti deleniti nulla.",
"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",
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC",
"productTierFeatures": {"BILLING": {"enabled": false
},
"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",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234"
},
"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",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"managedResourceType": "PortsBasedProxy",
"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
}
},
{"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
}
},
{"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
}
},
{"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": "Ut aut nisi.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
},
{"awsAccountID": "123456789012",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"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
],
"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": "Tenetur corrupti corrupti deleniti nulla.",
"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",
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC",
"productTierFeatures": {"BILLING": {"enabled": false
},
"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",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234"
},
"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",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"managedResourceType": "PortsBasedProxy",
"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
}
},
{"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
}
},
{"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
}
},
{"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": "Ut aut nisi.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
},
{"awsAccountID": "123456789012",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"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
],
"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": "Tenetur corrupti corrupti deleniti nulla.",
"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",
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC",
"productTierFeatures": {"BILLING": {"enabled": false
},
"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",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234"
},
"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",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"managedResourceType": "PortsBasedProxy",
"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
}
},
{"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
}
},
{"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
}
},
{"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": "Ut aut nisi.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"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|PRIVATE_VPC_PEERING|PRIVATE_LINK|INTERNAL",
"targetRestoreTime": "2021-09-01T00:00:00Z"
}

Response samples

202

Content type

application/json

{"id": "Itaque magni."
}

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

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=Laborum adipisci. Product tier version of the instance to describe. If not specified, the latest version is described.
ProductTierId	string Example: ProductTierId=Consequatur ipsa fugit minima repellendus. Product tier id of the instance to describe. Needs to specified in combination with the product tier version
SubscriptionId	string Example: SubscriptionId=Omnis vitae veritatis. Subscription id of the instance to describe.

Responses

Response samples

200

Content type

application/json

{"environmentId": "se-12345678",
"nextPageToken": "next-token",
"resourceInstances": [{"awsAccountID": "123456789012",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"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
],
"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": "Tenetur corrupti corrupti deleniti nulla.",
"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",
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC",
"productTierFeatures": {"BILLING": {"enabled": false
},
"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",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234"
},
"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",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"managedResourceType": "PortsBasedProxy",
"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
}
},
{"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
}
},
{"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
}
},
{"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": "Ut aut nisi.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
},
{"awsAccountID": "123456789012",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"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
],
"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": "Tenetur corrupti corrupti deleniti nulla.",
"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",
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC",
"productTierFeatures": {"BILLING": {"enabled": false
},
"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",
"result_params": {"param1": "value1",
"param2": "value2"
},
"serverlessEnabled": true,
"status": "RUNNING",
"subscriptionId": "sub-abcd1234"
},
"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",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
},
{"Url": "https://one.newrelic.com/data-exploration/data-explorer/explorer",
"healthStatus": "UNHEALTHY",
"integrationType": "LOGS",
"message": "missing exporter secret configuration for gcp",
"scope": "INTERNAL"
}
],
"managedResourceType": "PortsBasedProxy",
"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
}
},
{"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
}
},
{"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
}
},
{"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": "Ut aut nisi.",
"serviceModelId": "sm-12345678",
"serviceModelName": "hosted",
"serviceModelType": "OMNISTRATE_HOSTED",
"serviceName": "mysql",
"subscriptionId": "sub-12345678",
"subscriptionOwnerName": "John Doe",
"tierVersion": "1.0",
"tierVersionReleasedAt": "2020-01-01T00:00:00Z",
"tierVersionReleasedByUserId": "user-12345678",
"tierVersionReleasedByUserName": "John Doe",
"tierVersionStatus": "Preferred|Active|Deprecated|Pending"
},
{"awsAccountID": "123456789012",
"cloudProvider": "aws",
"consumptionResourceInstanceResult": {"active": true,
"autoscalingEnabled": true,
"awsAccountID": "123456789012",
"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
],
"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": "Tenetur corrupti corrupti deleniti nulla.",
"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",
"maxReplicas": "1",
"minReplicas": "1",
"network_type": "PUBLIC",
"productTierFeatures": {"BILL

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

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

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

SearchInventory inventory-api

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ListServiceOfferings inventory-api

Authorizations:

query Parameters

Responses

Response samples

DescribeServiceOffering inventory-api

Authorizations:

path Parameters

query Parameters

Responses

Response samples

DescribeServiceOfferingResource inventory-api

Authorizations:

path Parameters

query Parameters

Responses

Response samples

RemoveCustomDNSFromResourceInstance inventory-api

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required