PUT /api/apis/versions/{ApiVersionID}/info

Updates information about an API version.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API; an API Admin or Business Admin.

This topic includes the following sections:

HTTP Method


Back to top



Back to top

Sample Request

The example below shows a request to update the basic information about the specified API version.

Request URL


Sample request headers

PUT /api/apis/versions/f7f250fc-8405-43e0-9073-0f56a918d676.acmepaymentscorp/info HTTP/1.1
Host: acmepaymentscorp.com
Accept: application/vnd.soa.v81+json
Content-Type: application/vnd.soa.v81+json

Sample request body

  "ApiDescription":"Swagger Slim Version",
  "VersionName":"Version 3",
  "VersionNotes":"Swagger Slim Version 3",

Back to top

Request Headers

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

Header Description

application/json, application/xml,

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v81+json or application/vnd.soa.v81+xml

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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path String Required The unique ID for a specific API version.
EditApiInfoRequest Body EditApiInfoRequest Required Contains information about a request to edit API info.

Back to top


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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v81+json

HTTP/1.1 200 OK
Date: Thu, 28 Apr 2016 21:05:34 GMT
Content-Type: application/vnd.soa.v81+json

Sample response body: application/vnd.soa.v81+json

  "APIVersionID" : "f7f250fc-8405-43e0-9073-0f56a918d676.acmepaymentscorp",
  "Environment" : "Production",
  "Name" : "Version 3",
  "Description" : "Swagger Slim Version 3",
  "APIInfo" : {
    "APIID" : "b1d965dc-d560-416f-84af-0e60f1cbd199.acmepaymentscorp",
    "Name" : "Swagger_Slim",
    "Description" : "Swagger Slim Version",
    "AvatarURL" : "http://acmepaymentscorp.com/api/apis/avatar/_V0V1TQaVuDB9uPb-Gau-Qjg"
  "Tags" : [ "slim", "v3" ],
  "Visibility" : "Public"

Back to top

Sample response headers: application/vnd.soa.v81+xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v81+xml
Date: Thu, 28 Apr 2016 21:09:56 GMT

Sample response body: application/vnd.soa.v81+xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIVersionInfo xmlns="http://soa.com/xsd/api/1.0" xmlns:ns2="http://soa.com/xsd/business/1.0" 
xmlns:ns3="http://soa.com/xsd/deploymentzone/1.0" xmlns:ns4="http://soa.com/xsd/asset/1.0" 
xmlns:ns5="http://soa.com/xsd/legals/1.0" xmlns:ns6="http://soa.com/xsd/dnmodel/1.0" 
  <Name>Version 3</Name>
  <Description>Swagger Slim Version 3 UPDATED IN RESTCLIENT</Description>
    <Description>Swagger Slim Version</Description>

Back to top

Response Headers

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

Header Description

application/json, application/xml,

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Response Body

Name Type Description
APIVersionInfo APIVersionInfo Contains API version info for an API defined using a Swagger 2.0 description document.

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. 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.

Back to top

Related Topics