PUT /api/apis/versions/{APIVersionID}/extensions

Updates the Lifecycle Manager extension properties for the specified 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

PUT

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/extensions

Back to top

Sample Request

The example below shows a request to modify the Lifecycle Manager extension properties for the specified API version.

Request URL

https://{hostname}/api/apis/versions/f26d1a80-2ab8-4a1a-a4de-d3854d621b01.acmepaymentscorp/extensions

Sample request headers

Accept: */*
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "classifiers":{
    "name":[
      "AccountInfo-Manual_Cert"
    ],
    "version":[
      "v1"
    ],
    "description":[
      ""
    ],
    "1-status":[
      "In Development"
    ],
    "3-scope":[
      "App-specific"
    ],
    "4-visibility":[
      "false"
    ],
    "5-sensitive":[
      "true"
    ],
    "6-provider":[
      "Jane Mead (JM)"
    ],
    "7-is-consumer":[
      "false"
    ],
    "8-authentication-method":[
      "Client Certificate"
    ]
  },
  "artifacts":{
    "design-document":"http://www.google.com",
    "source-code":"http://www.google.com"
  }
}

Back to top

Request Headers

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

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type application/json, application/vnd.soa.v83+json
AtmoAuthToken_{fedmemberid} The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login.
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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with...

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain

Sample response body

f26d1a80-2ab8-4a1a-a4de-d3854d621b01.acmepaymentscorp

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
APIVersionID String The unique ID for a specific API version.

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