Create Instance
This API creates a new instance on a subscription asynchronously. The value corresponding to jobId in the response can be used in the Get Job by Id API call to get the instance creation status.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the api is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Body (application/json)
| Name | Type | Required | Notes |
| name | string | max 30 chars | |
| displayName | string | max 30 chars | |
| subscriptionName | string | ||
| planName | string | ||
| type | string |
production|sandbox|trial|demo|internal
|
Example
Request Sample
curl --request POST --url https://api.syncari.com/api/v1/instances \
--header 'Accept: application/json' \
--header 'Authorization: FTON46895FBIl' \
--header 'Content-Type: application/json' \
--header 'clientRequestId: 123456789' \
--header 'syncariId: VBKIUF' \
--data '{
"name": "Instance 1",
"displayName": "Instance 1",
"subscriptionName": "Subscription Name",
"planName": "default",
"type": "production"
}'
Response Sample
{
"success": true,
"requestId": "5766595378",
"timestamp": "2022-07-28T06:26:47.100883Z",
"result": {
"jobId": "62e22c26a8ccd6ac1c2e97c3",
"status": "queued",
"jobDetails": {
"displayName": "async test",
"subscriptionName": "Syncari Master",
"name": "async test",
"planName": "default",
"type": "sandbox"
}
}
}
List Instances
Use this endpoint to list all instances in a subscription. Every instance has a unique identifier named syncariId.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the api is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Example
Request Sample
curl --request POST --url https://api.syncari.com/api/v1/instances \
--header 'Accept: application/json' \
--header 'Authorization: FTON46895FBIl' \
--header 'Content-Type: application/json' \
--header 'clientRequestId: 123456789' \
--header 'syncariId: VBKIUF'
Response Sample
{
"success": true,
"requestId": "8879688424",
"timestamp": "2023-03-23T22:59:49.087954Z",
"result": [
{
"name": "Syncari Master Instance",
"displayName": "Syncari Master Instance",
"syncariId": "syncari_admin",
"type": "production",
"status": null,
"planName": null,
"subscriptionName": "Syncari Master",
"quota": null
},
{
"name": "testnewinstance",
"displayName": "testTrialDisplayName&Edited",
"syncariId": "GYGQLU",
"type": "production",
"status": "ACTIVE",
"planName": "default",
"subscriptionName": "Syncari Master",
"quota": null
},
{
"name": "testnewinstance",
"displayName": "testnewinstance",
"syncariId": "GFIVQ6",
"type": "production",
"status": "ACTIVE",
"planName": "default",
"subscriptionName": "Syncari Master",
"quota": null
},
{
"name": "testOrgAd",
"displayName": "testOrgDN",
"syncariId": "LGSKOM",
"type": "production",
"status": "ACTIVE",
"planName": "default",
"subscriptionName": "Syncari Master",
"quota": null
}
]
}
Delete Instance
This API deletes instance.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the api is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Response Sample
{
"success": true,
"requestId": "2212082787",
"timestamp": "2024-06-18T21:24:39.121409Z",
"result": {
"id": "Successfully deprovisioned instance GFIVQ6"
}
}