Edit a version

put

https://{hostname}/api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}

Updates details about an endpoint version that has never been activated on the staging or production network. You can configure the endpoint's security settings and other top-level metadata, or modify the endpoint's entire set of resources as an alternative to separate calls to Edit a resource. Note that the corresponding Get a version operation you need to run to GET the data uses a different URL.

Path Params

versionNumber

integer

required

The unique identifier for the endpoint version.

apiEndPointId

integer

required

The unique identifier for the endpoint.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

akamaiSecurityRestrictions

object | null

The App & API Protector security restrictions that you apply to an API. Note that you should only include these details in your requests if you're a App & API Protector customer.

apiCategoryIds

array of integers | null

The category identifiers that apply to the endpoint. The value is null for uncategorized endpoints.

apiCategoryIds

apiEndPointHosts

array of strings

required

length ≥ 1

The hostnames that may receive traffic for the endpoint. You need at least one hostname before activating the endpoint.

apiEndPointHosts*

apiEndPointName

string

required

The name of the endpoint, unique within the account.

apiEndPointScheme

string | null

enum

The URL scheme to which the endpoint may respond, either http, https, or http/https for both.

Allowed:

apiGatewayEnabled

boolean | null

Defaults to true

Whether the API Gateway product should be enabled for the endpoint. If null, the member is set to true.

apiSource

string | null

enum

Specifies if the API's data comes from API_DISCOVERY or was provided by the USER.

Allowed:

apiVersionInfo

object | null

A major API version. This refers to REST API versioning and is a different concept than the endpoint configuration versions you create at Akamai.

basePath

string | null

The URL path that serves as a root prefix for all resources' resourcePath values. This is / if empty. Don't append a / character to the path. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

caseSensitive

boolean | null

Whether the URLs and parameters within the endpoint are case sensitive.

consumeType

string | null

enum

The content type the endpoint exchanges, either json, xml, urlencoded, json/xml/urlencoded, json/urlencoded, json/xml, or xml/urlencoded for multi-format APIs, any, or none. A null value is the same as a none string.

description

string | null

The description of the endpoint. If you specify null in the request or omit this member from the object, the JSON response reflects it as an empty string.

discoveredPiiIds

array of integers | null

Personally identifiable information (PII) in your API parameters discovered by the network.

discoveredPiiIds

isGraphQL

boolean

Whether the endpoint uses GraphQL to deliver structured content to clients.

matchPathSegmentParam

boolean | null

Defaults to true

Whether or not to include path segment parameters in match criteria, like the jsessionid portion of /ssocookie;jsessionid=434343.

positiveConstrainsEnabled

boolean | null

Specifies whether the App & API Protector firewall policies are enabled for the endpoint.

securityScheme

object | null

The key with which users may access the endpoint.

versionNumber

integer | null

The endpoint version number.

apiResources

array of objects | null

Resources assigned to the endpoint.

apiResources

200Modify details of an endpoint version.

400Bad request. Some of the request input is invalid.

403Forbidden. You don't have access to the endpoint.

404Not found. The API endpoint doesn't exist.

409Conflict