List versions

get

https://{hostname}/api-definitions/v2/endpoints/{apiEndPointId}/versions

Returns versions of an endpoint, with results optionally paginated, sorted, and filtered.

Path Params

apiEndPointId

integer

required

The unique identifier for the endpoint.

Query Params

page

integer

Defaults to 1

The page number index, starting at the default value of 1.

pageSize

integer

Defaults to 2147483647

The number of endpoint versions on each page of results.

sortBy

string

enum

Defaults to versionNumber

Enum The field to sort endpoint versions by, versionNumber by default.

Allowed:

sortOrder

string

enum

Defaults to desc

Enum The sort order, either asc for ascending or the default desc for descending.

Allowed:

show

string

enum

Defaults to ALL

Enum The type of endpoint versions to return based on their visibility status. By default the API returns ALL endpoint version. You can instead decide to return ONLY_VISIBLE endpoint versions, or ONLY_HIDDEN endpoint versions. Run the Show a version and Hide a version operations to control which endpoint versions are listed.

Allowed:

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Response body

object

All versions of an endpoint.

apiEndPointId

integer

required

The unique identifier for the endpoint.

apiEndPointName

string

The name of the endpoint, unique within the account.

apiVersions

array of objects

Each endpoint version within a collection.

apiVersions

object

apiEndPointVersionId

integer

The unique identifier for the endpoint version.

availableActions

array of strings

Available actions that you can perform on the version depending on the version's activation status.

CLONE_ENDPOINT CLONE_VERSION DELETE RESOURCES COMPARE_ENDPOINT COMPARE_AAG_SETTINGS COMPARE_RESOURCE_PURPOSES COMPARE_RAPID_SETTINGS VIEW_AAG_SETTINGS EDIT_AAG_SETTINGS EDIT_ENDPOINT_DEFINITION ACTIVATE_ON_STAGING ACTIVATE_ON_PRODUCTION DEACTIVATE_ON_STAGING DEACTIVATE_ON_PRODUCTION HIDE_VERSION SHOW_VERSION

basePath

string | null

The URL path that serves as a root prefix for all resources' resourcePath values. This is / if empty. Don't append a / character to the path. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

basedOn

integer | null

For cloned versions, the unique identifier for the source version.

createDate

date-time

The ISO 8601 timestamp indicating when you created the endpoint version.

createdBy

string

The identifier for the user who created the version.

description

string | null

The description of the endpoint version. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

hidden

boolean

Indicates whether the endpoint version is hidden. You cannot activate or delete hidden versions. If you want to do so, you first need to reveal the version by running the Show a version operation.

isVersionLocked

boolean

Whether the endpoint version is read-only.

lockVersion

integer

required

The identifier for the last modification of an endpoint version, used for optimistic locking. See Concurrency control for details.

productionDate

date-time | null

The ISO 8601 timestamp indicating when you activated the endpoint version on the production network.

productionStatus

string | null

enum

The version activation status on the production network, either PENDING if the version contains changes that are being propagated to the network, ACTIVE if the version is active, DEACTIVATED if the version was once active but is deactivated, or FAILED if an activation or deactivation attempt for this version has failed. The value is null for versions that have never been activated on this network.

PENDING ACTIVE DEACTIVATED FAILED

stagingDate

date-time | null

The ISO 8601 timestamp indicating when you activated the endpoint version on the staging network.

stagingStatus

string | null

enum

The version activation status on the staging network, either PENDING if the version contains changes that are being propagated to the network, ACTIVE if the version is active, DEACTIVATED if the version was once active but is deactivated, or FAILED if an activation or deactivation attempt for this version has failed. The value is null for versions that have never been activated on this network.

PENDING ACTIVE DEACTIVATED FAILED

updateDate

date-time

The ISO 8601 timestamp indicating when you last modified the endpoint version.

updatedBy

string

The identifier for the user who last modified the version.

versionNumber

integer

required

The endpoint version number.

page

integer

≥ 1

Defaults to 1

The number of the current page with results.

pageSize

integer

Defaults to 2147483647

The number of endpoint versions on each page with results.

totalSize

integer

The total number of endpoint versions available in the returned set.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/api-definitions/v2/endpoints/apiEndPointId/versions \
3
     --header 'accept: application/json'


xxxxxxxxxx
71
}
1
{
2
  "apiEndPointId": 492375,
3
  "apiEndPointName": "Bookstore API",
4
  "apiVersions": [
5
    {
6
      "apiEndPointVersionId": 599104,
7
      "availableActions": [
8
        "ACTIVATE_ON_PRODUCTION",
9
        "VIEW_AAG_SETTINGS",
10
        "COMPARE_RAPID_SETTINGS",
11
        "EDIT_AAG_SETTINGS",
12
        "HIDE_VERSION",
13
        "CLONE_VERSION",
14
        "EDIT_ENDPOINT_DEFINITION",
15
        "COMPARE_ENDPOINT",
16
        "RESOURCES",
17
        "ACTIVATE_ON_STAGING",
18
        "DELETE"
19
      ],
20
      "basePath": "/bookstore2",
21
      "basedOn": 1,
22
      "createDate": "2019-06-17T07:22:29+0000",
23
      "createdBy": "bookstore_admin",
24
      "description": "An API for bookstore users allowing them to retrieve book items, add new items (admin users), and modify existing items.",
25
      "hidden": false,
26
      "isVersionLocked": false,
27
      "lockVersion": 2,
28
      "productionDate": null,
29
      "productionStatus": null,
30
      "stagingDate": null,
31
      "stagingStatus": null,
32
      "updateDate": "2019-06-17T07:23:11+0000",
33
      "updatedBy": "bookstore_admin",
34
      "versionNumber": 2
35
    },
36
    {
37
      "apiEndPointVersionId": 574127,
38
      "availableActions": [
39
        "VIEW_AAG_SETTINGS",
40
        "EDIT_AAG_SETTINGS",
41
        "EDIT_ENDPOINT_DEFINITION",
42
        "DELETE",
43
        "ACTIVATE_ON_STAGING",
44
        "COMPARE_RAPID_SETTINGS",
45
        "ACTIVATE_ON_PRODUCTION",
46
        "COMPARE_ENDPOINT",
47
        "CLONE_VERSION",
48
        "RESOURCES",
49
        "HIDE_VERSION"

200Lists API endpoint versions you have access to in this account.

403Forbidden. You don't have permission to retrieve the API endpoint versions list.