Skip to content

Read provisioning profiles

About

Returns provisioning profiles

GET /users/current/provisioning-profiles

For more information see swagger documentation

Headers

Name Type Required Description
auth-token string Yes Authorization token. See Authentication and authorization
api-version string Api version, allowed values are 1 and 2 (defaults to 1)

Path parameters

Name Type Required Description
id string Yes Id of the profile to retrieve

Query parameters

Name Type Required Description
version integer Filter provisioning profile by version. Allowed values is 4 and 5. Other values will be ignored.
status string Filter provisioning profile by status. Allowed values is new and active. Other values will be ignored.
type string Yes Provisioning profile type, enum mtTerminal, managerApi, managerUi. Other values will be ignored.
offset number Provisioning profiles search offset (defaults to 0) (must be greater or equal to 0)
limit number Provisioning profiles search limit (defaults to 1000) (must be greater or equal to 1 and less or equal to 1000)
query string Partially search over provisioning profile name to match query

Response

Examples

Example request:

curl -X GET --header 'Accept: application/json' --header 'auth-token: token' 'https://mt-provisioning-api-v1.agiliumtrade.agiliumtrade.ai/users/current/provisioning-profiles?version=5&status=new'

Example response (default):

[
  {
    "_id": "f9ce1f12-e720-4b9a-9477-c2d4cb25f076",
    "name": "test",
    "version": 5,
    "status": "new",
    "brokerTimezone": "EET",
    "brokerDSTSwitchTimezone": "EET",
    "type": "mtTerminal"
  }
]

Example response for api-version 2:

{
  "count": 1,
  "items": [
    {
      "_id": "f9ce1f12-e720-4b9a-9477-c2d4cb25f076",
      "name": "test",
      "version": 5,
      "status": "new",
      "brokerTimezone": "EET",
      "brokerDSTSwitchTimezone": "EET",
      "type": "mtTerminal"
    }
  ]
}