GET /api/apis/{APIID}/versions
Returns a list of versions associated with the specified API, as an RSS channel.
Note: version information does not include operations. For information about operations for a specific API version, use GET /api/apis/versions/{APIVersionID} with the optional includeOperations parameter.
Authorization Roles/Permissions: Must have Read permission for the resource.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/apis/{APIID}/versions
Sample Request
The example below show a request for a list of valid versions for the specified API.
Sample Request URL
https://{hostname}/api/apis/api18969.acmepaymentscorp/versions
Sample request headers
GET /api/apis/api18969.acmepaymentscorp/versions HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
Not applicable.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept | application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json |
| Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
| X-Csrf-Token_{fedmemberID} | The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login. |
Request Parameters
| Parameter | Parm Type | Data Type | Required | Description |
|---|---|---|---|---|
| APIID | Path | string | Required | The unique ID for a specific API. |
Response
If successful, this operation returns HTTP status code 200, with information about the API versions in the form of an RSS feed.
Sample Response
The sample response below shows that there are two versions of the API. Version 1 is public and has a sandbox implementation; Version 2 is private and has a live implementation. Each version has one endpoint.
Sample response headers
HTTP/1.1 200 OK Date: Wed, 18 Aug 2021 18:06:53 GMT Content-Type: application/json
{
"channel":{
"title":"API Versions",
"item":[
{
"title":"Version 2 (Private, Live)",
"description":"",
"category":[
{
"value":"apiversion",
"domain":"uddi:soa.com:resourcetype"
},
{
"value":"com.soa.api.state.open",
"domain":"uddi:soa.com:state"
},
{
"value":"Limited",
"domain":"uddi:soa.com:visibility"
},
{
"value":"uddi:soa.com:api:resource-level-permissions-notsupported",
"domain":"uddi:soa.com:api:resource-level-permissions"
},
{
"value":"finance",
"domain":"uddi:soa.com:tag"
},
{
"value":"private",
"domain":"uddi:soa.com:tag"
},
{
"value":"acmepaymentscorp",
"domain":"uddi:soa.com:tag"
}
],
"guid":{
"value":"73564f84-9eb0-4ab7-84fd-ac4f4c953185.rcoaless"
},
"pubDate":"Wed, 18 Aug 2021 18:20:16 +0000",
"Endpoints":{
"Endpoint":[
{
"Category":"Production",
"Uri":"https://api652069live.gateway.akana.com:443/",
"CName":"api652069live.gateway.akana.com",
"DeploymentZoneRule":"container-1051default-https",
"ConnectionProperties":[
{
"Name":"virtualHost",
"Value":"api652069live.gateway.akana.com"
},
{
"Name":"gateway_hostname",
"Value":"api652069live.gateway.akana.com"
},
{
"Name":"visibility",
"Value":"public"
}
],
"BindingQName":"{My_ACME_Payments_Corp_API_1}My_ACME_Payments_Corp_API__Binding_0_0_0",
"BindingType":"binding.http",
"EndpointKey":"uddi:a8e7cb07-5138-4dde-aa88-2a5d4e0274dd",
"EndpointImplementationDetails":{
"DeploymentZoneEndpoint":{
"DeploymentZoneID":"container-1051.rcoaless",
"EndpointKey":"uddi:a8e7cb07-5138-4dde-aa88-2a5d4e0274dd",
"ListenerName":"default-https",
"ContainerKey":"container-1051",
"GatewayHostName":"api652069live.gateway.akana.com",
"GatewayHostPath":"/",
"EndpointHostName":"api652069live.gateway.akana.com",
"EndpointPath":"/",
"Protocol":"https",
"Path":"/",
"Url":"https://api652069live.gateway.akana.com:443/",
"BindingQName":"{My_ACME_Payments_Corp_API_1}My_ACME_Payments_Corp_API__Binding_0_0_0",
"BindingType":"binding.http",
"Public":true
}
},
"ImplementationCode":"Live"
}
]
},
"Endpoint":{
"Category":"Production",
"Uri":"https://api652069live.gateway.akana.com:443/",
"CName":"api652069live.gateway.akana.com",
"DeploymentZoneRule":"container-1051default-https",
"ConnectionProperties":[
{
"Name":"virtualHost",
"Value":"api652069live.gateway.akana.com"
},
{
"Name":"gateway_hostname",
"Value":"api652069live.gateway.akana.com"
},
{
"Name":"visibility",
"Value":"public"
}
],
"BindingQName":"{My_ACME_Payments_Corp_API_1}My_ACME_Payments_Corp_API__Binding_0_0_0",
"BindingType":"binding.http",
"EndpointKey":"uddi:a8e7cb07-5138-4dde-aa88-2a5d4e0274dd",
"EndpointImplementationDetails":{
"DeploymentZoneEndpoint":{
"DeploymentZoneID":"container-1051.rcoaless",
"EndpointKey":"uddi:a8e7cb07-5138-4dde-aa88-2a5d4e0274dd",
"ListenerName":"default-https",
"ContainerKey":"container-1051",
"GatewayHostName":"api652069live.gateway.akana.com",
"GatewayHostPath":"/",
"EndpointHostName":"api652069live.gateway.akana.com",
"EndpointPath":"/",
"Protocol":"https",
"Path":"/",
"Url":"https://api652069live.gateway.akana.com:443/",
"BindingQName":"{My_ACME_Payments_Corp_API_1}My_ACME_Payments_Corp_API__Binding_0_0_0",
"BindingType":"binding.http",
"Public":true
}
},
"ImplementationCode":"Live"
}
},
{
"title":"Version 1 (Public, Sandbox)",
"description":"My ACME Payments Corp API",
"category":[
{
"value":"apiversion",
"domain":"uddi:soa.com:resourcetype"
},
{
"value":"com.soa.api.state.open",
"domain":"uddi:soa.com:state"
},
{
"value":"Public",
"domain":"uddi:soa.com:visibility"
},
{
"value":"uddi:soa.com:api:resource-level-permissions-notsupported",
"domain":"uddi:soa.com:api:resource-level-permissions"
},
{
"value":"finance",
"domain":"uddi:soa.com:tag"
},
{
"value":"acmepaymentscorp",
"domain":"uddi:soa.com:tag"
},
{
"value":"public",
"domain":"uddi:soa.com:tag"
}
],
"guid":{
"value":"4631598c-1d03-4699-ac18-d49456d69b43.rcoaless"
},
"pubDate":"Wed, 18 Aug 2021 18:21:20 +0000",
"Endpoints":{
"Endpoint":[
{
"Category":"Sandbox",
"Uri":"https://api652064sandbox.gateway.akana.com:443/",
"CName":"api652064sandbox.gateway.akana.com",
"DeploymentZoneRule":"container-1051default-https",
"ConnectionProperties":[
{
"Name":"virtualHost",
"Value":"api652064sandbox.gateway.akana.com"
},
{
"Name":"gateway_hostname",
"Value":"api652064sandbox.gateway.akana.com"
},
{
"Name":"visibility",
"Value":"public"
}
],
"BindingQName":"{My_ACME_Payments_Corp_API_1}My_ACME_Payments_Corp_API__Binding_0",
"BindingType":"binding.http",
"EndpointKey":"uddi:2a9a297a-9ec5-4ccb-8eee-c089c8edda59",
"EndpointImplementationDetails":{
"DeploymentZoneEndpoint":{
"DeploymentZoneID":"container-1051.rcoaless",
"EndpointKey":"uddi:2a9a297a-9ec5-4ccb-8eee-c089c8edda59",
"ListenerName":"default-https",
"ContainerKey":"container-1051",
"GatewayHostName":"api652064sandbox.gateway.akana.com",
"GatewayHostPath":"/",
"EndpointHostName":"api652064sandbox.gateway.akana.com",
"EndpointPath":"/",
"Protocol":"https",
"Path":"/",
"Url":"https://api652064sandbox.gateway.akana.com:443/",
"BindingQName":"{My_ACME_Payments_Corp_API_1}My_ACME_Payments_Corp_API__Binding_0",
"BindingType":"binding.http",
"Public":true
}
},
"ImplementationCode":"Sandbox"
}
]
},
"Endpoint":{
"Category":"Sandbox",
"Uri":"https://api652064sandbox.gateway.akana.com:443/",
"CName":"api652064sandbox.gateway.akana.com",
"DeploymentZoneRule":"container-1051default-https",
"ConnectionProperties":[
{
"Name":"virtualHost",
"Value":"api652064sandbox.gateway.akana.com"
},
{
"Name":"gateway_hostname",
"Value":"api652064sandbox.gateway.akana.com"
},
{
"Name":"visibility",
"Value":"public"
}
],
"BindingQName":"{My_ACME_Payments_Corp_API_1}My_ACME_Payments_Corp_API__Binding_0",
"BindingType":"binding.http",
"EndpointKey":"uddi:2a9a297a-9ec5-4ccb-8eee-c089c8edda59",
"EndpointImplementationDetails":{
"DeploymentZoneEndpoint":{
"DeploymentZoneID":"container-1051.rcoaless",
"EndpointKey":"uddi:2a9a297a-9ec5-4ccb-8eee-c089c8edda59",
"ListenerName":"default-https",
"ContainerKey":"container-1051",
"GatewayHostName":"api652064sandbox.gateway.akana.com",
"GatewayHostPath":"/",
"EndpointHostName":"api652064sandbox.gateway.akana.com",
"EndpointPath":"/",
"Protocol":"https",
"Path":"/",
"Url":"https://api652064sandbox.gateway.akana.com:443/",
"BindingQName":"{My_ACME_Payments_Corp_API_1}My_ACME_Payments_Corp_API__Binding_0",
"BindingType":"binding.http",
"Public":true
}
},
"ImplementationCode":"Sandbox"
}
}
]
},
"version":"1.0"
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json |
Response Body
The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS channel is API versions. Each item in the channel represents one API version, and includes the information listed below.
| Name | Description |
|---|---|
| title | The title of the RSS channel; in this case, API Versions. |
| Item |
An array of individual items, each of which represents an API version. For each item:
For an example, see Sample response body (JSON) above. |
Error Codes/Messages
If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.
| Item | Value |
|---|---|
| 401 | Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. |
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.
