Status¶

https://{cluster-id}.api.esales.apptus.cloud/api/admin/v3/import/status

GET¶

Import status endpoint can be used to check the status of an ongoing import, the identifier of the import is returned when you start an import.

Request¶

Header parameters¶

Name	Description	Example
Api-Key Required	Api-key that was supplied during on-boarding	`pkA123456789AB1BE..`
Accept-Encoding	Allows responses to be compressed using Gzip.	`gzip`

Query parameters¶

Name	Description	Example
id Required	Id of import, which was returned when starting an import. e.g.	`5537431447739019570`

curl -i \
-X GET \
-H 'Api-Key: pkA123456789AB1BE..' \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.api.esales.apptus.cloud/api/admin/v3/import/status?id=5537431447739019570"

Response¶

Response codes¶

Status	Description
200	A description of the specified import's status.
404	Cluster not found.
500	Server error such as cluster unavailable, busy or internal error. If 5xx errors persist, contact support and attach any information found in the response body.

Response body¶

Example

application/json;charset=UTF-8

{
  "id" : 5537431447739019570,
  "reason" : null,
  "status" : "IN_PROGRESS"
}

Schema

StatusResponse¶

The status of an import based on its id.

Name	Type	Description	Example
id	string	The id of the import	`5537431447739019570`
reason	string	The reason for the status. e.g. an error message from the import
status	string	The current status of the import Supported values: `NOT_FOUND`, `WAITING`, `BLOCKED`, `IN_PROGRESS`, `SUCCESS`, `FAILURE`, `ABORTED`.	`"IN_PROGRESS"`