GET /api/apis/{APIID}

Returns information about an API.

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/{APIID}[?includeDefaultVersion=boolean][?IncludeSettings=boolean]

Back to top

Sample Request

The example below shows a request for a specific API.

Request URL

https://{hostname}/api/apis/12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp

Sample request headers

GET /api/apis/12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept

Any of the following media types is valid for the Accept header:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json, application/vnd.soa.v83+json

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIID Path string Required The unique ID for a specific API.
includeDefaultVersion Query boolean Optional Indicates whether to include the default version in the information returned. If not specified, defaults to false.
IncludeSettings Query boolean Optional Indicates whether the settings for the resource should be included in the response. If not specified, defaults to false.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the API.

Back to top

Sample Response

The sample response below shows the information returned about the ACME Payments API. The information is returned as a JSON object.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 18 Jul 2014 11:59:09 GMT
Content-Type: application/json

Sample response body

{
  "APIID" : "12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp",
  "Name" : "ACME Payments API",
  "Description" : "Payments API for ACME customers.",
  "Visibility" : "Public",
  "LatestVersionID" : "961d2b7d-0f70-4978-b05d-c45dc333e067.acmepaymentscorp",
  "IsFollowed" : false,
  "RatingSummary" : {
    "Five" : 0,
    "Four" : 0,
    "Three" : 0,
    "Two" : 0,
    "One" : 0
  },
  "AdminGroupID" : "apiadmin-12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp",
  "Created" : "2014-07-18T15:43:09Z",
  "Updated" : "2014-07-18T15:44:51Z",
  "AvatarURL" : "http://{hostname}/api/apis/12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp/avatar"
}

Sample response body with optional request parameter IncludeSettings=true

{
  "APIID" : "12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp",
  "Name" : "ACME Payments API",
  "Description" : "Payments API for ACME customers.",
  "Visibility" : "Public",
  "LatestVersionID" : "961d2b7d-0f70-4978-b05d-c45dc333e067.acmepaymentscorp",
  "IsFollowed" : false,
  "RatingSummary" : {
    "Five" : 0,
    "Four" : 0,
    "Three" : 0,
    "Two" : 0,
    "One" : 0
  },
  "AdminGroupID" : "apiadmin-12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp",
  "Created" : "2014-07-18T15:43:09Z",
  "Updated" : "2014-07-18T15:44:51Z",
  "AvatarURL" : "http://{hostname}/api/apis/12770263-e036-4222-b8eb-87d33676d3ad.acmepaymentscorp/avatar",
  "APISettings" : {
    "PublicAPISupport" : "com.soa.feature.enabled",
    "PublicAPISandboxEndpointSupport" : "com.soa.feature.enabled",
    "PublicAPIProductionEndpointSupport" : "com.soa.feature.enabled",
    "PublicAPISandboxAutoApprovalSupport" : "com.soa.feature.enabled",
    "PublicAPIProductionAutoApprovalSupport" : "com.soa.feature.enabled",
    "PublicAPIBoardSupport" : "com.soa.feature.enabled",
    "PublicAPIRatingsSupport" : "com.soa.feature.enabled",
    "PublicAPIReviewsSupport" : "com.soa.feature.enabled",
    "PrivateAPISupport" : "com.soa.feature.enabled",
    "PrivateAPISandboxEndpointSupport" : "com.soa.feature.enabled",
    "PrivateAPIProductionEndpointSupport" : "com.soa.feature.enabled",
    "PrivateAPISandboxAutoApprovalSupport" : "com.soa.feature.enabled",
    "PrivateAPIProductionAutoApprovalSupport" : "com.soa.feature.enabled",
    "PrivateAPIGroupTypeSupport" : "com.soa.feature.disabled",
    "PrivateAPIIndependentGroupSupport" : "com.soa.feature.enabled",
    "PrivateAPIBoardSupport" : "com.soa.feature.enabled",
    "PrivateAPIRatingsSupport" : "com.soa.feature.enabled",
    "PrivateAPIReviewsSupport" : "com.soa.feature.enabled",
    "PublicAPIResourceLevelPermissionsSupport" : "com.soa.feature.enabled",
    "PrivateAPIResourceLevelPermissionsSupport" : "com.soa.feature.enabled"
  }
}

Back to top

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, application/vnd.soa.v81+json, application/vnd.soa.v83+json

Back to top

Response Body

Name Type Description
API API Includes information about an API.

Back to top

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.
404 The resource could not be found. For example, you might get this if you include an invalid APIID in the request.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics