GET /api/apis

Returns a list of all APIs on the platform. With an optional parameter, lists APIs owned by a specific business organization.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/apis[?BusinessID={BusinessID}][&Federation={Federation}]

Sample Request

The example below shows a request without the optional parameters.

Sample Request URL 

https://{hostname}/api/apis

Sample request headers 

GET /api/apis 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, text/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
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
BusinessID Query string Optional

The unique ID for a specific business organization on the platform.

If this parameter is included, only APIs relating to the specified organization are returned.
Federation Query boolean Optional

Indicates whether the current implementation is a federation.

If not specified, defaults to true.

Response

If successful, this operation returns HTTP status code 200, with the list of APIs. The information is sent as an RSS channel in JSON or XML format.

Sample Response

The sample response below shows the results of a request without the optional parameters, when there are three APIs on the platform. Both JSON and XML examples are provided.

Sample response headers: application/json 

HTTP/1.1 200 OK
Date: Wed, 29 Jul 2020 14:30:37 GMT
Content-Type: application/json

Sample response body: application/json 

{
  "channel": {
    "title": "APIs",
    "item": [
      {
        "title": "httpbin",
        "category": [
          {
            "value": "api",
            "domain": "uddi:soa.com:resourcetype"
          },
          {
            "value": "Public",
            "domain": "uddi:soa.com:visibility"
          }
        ],
        "guid": {
          "value": "b5662e48-8bb0-421a-9838-fe13cf4c70df.acmepaymentscorp"
        },
        "pubDate": "Wed, 29 Jul 2020 13:55:27 +0000",
        "EntityReferences": {
          "EntityReference": [
            {
              "Title": "httpbin (1)",
              "Guid": "6b0a6f4c-3d2e-4fa0-aaa1-f619a360f8ec.acmepaymentscorp",
              "Category": [
                {
                  "value": "apiversion",
                  "domain": "uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        },
        "EntityReference": {
          "Title": "httpbin (1)",
          "Guid": "6b0a6f4c-3d2e-4fa0-aaa1-f619a360f8ec.acmepaymentscorp",
          "Category": [
            {
              "value": "apiversion",
              "domain": "uddi:soa.com:resourcetype"
            }
          ]
        },
        "Image": {
          "Url": "http://api.acmepaymentscorp.com/api/apis/avatar/_VHqr2PDtS1ZXuNvh-PeT7Mw"
        }
      },
      {
        "title": "Swagger_Petstore_5_Operations",
        "category": [
          {
            "value": "api",
            "domain": "uddi:soa.com:resourcetype"
          },
          {
            "value": "Public",
            "domain": "uddi:soa.com:visibility"
          }
        ],
        "guid": {
          "value": "37c792db-e763-4abf-a6c1-2dd2ecc47b7f.acmepaymentscorp"
        },
        "pubDate": "Wed, 29 Jul 2020 13:56:19 +0000",
        "EntityReferences": {
          "EntityReference": [
            {
              "Title": "Swagger_Petstore_5_Operations (v1)",
              "Guid": "ef8e5dd5-3036-4342-97ec-98232cc36899.acmepaymentscorp",
              "Category": [
                {
                  "value": "apiversion",
                  "domain": "uddi:soa.com:resourcetype"
                }
              ]
            }
          ]
        },
        "EntityReference": {
          "Title": "Swagger_Petstore_5_Operations (v1)",
          "Guid": "ef8e5dd5-3036-4342-97ec-98232cc36899.acmepaymentscorp",
          "Category": [
            {
              "value": "apiversion",
              "domain": "uddi:soa.com:resourcetype"
            }
          ]
        },
        "Image": {
          "Url": "http://api.acmepaymentscorp.com/api/apis/avatar/_VHqr2PDtS1ZXuNvh-PeT7Mw"
        }
      }
    ]
  },
  "version": "1.0"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, text/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml

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 APIs. Each item in the channel represents one API, and includes the information listed below.

Name Description
title The name of the API.
description The text description for the API.
category[ ]

An array of sets of two name/value pairs, each including Value and Domain, with a value for each. For example:

"value" : "api",
"domain" : "uddi:soa.com:resourcetype"

The example above indicates that the resource is an API.

"value" : "Public",
"domain" : "uddi:soa.com:visibility"

The example above indicates that the API has a visibility setting of Public.
GUID GUID for the resource. It is the unique APIID; for example, api102.acmepaymentscorp.
pubdate The date the RSS channel was generated.
EntityReference

Entity references for the user who is the follower:

  • Title: The name of the API.
  • GUID: unique ID for the API version; the APIVersionID.
  • Category: a set of two name/value pairs expressing information about the API version. For example: 
    "value" : "apiversion",
"domain" : "uddi:soa.com:resourcetype"

    The example above indicates that the resource is an API version.

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.