Edit an endpoint from an API definition file

post

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

Imports an API definition file with details about an endpoint. Unlike Register an endpoint from an API definition file, this operation doesn't create a new endpoint, but updates details of an existing endpoint. You can run this operation in two ways. To POST JSON data, see Make a JSON request to edit an endpoint from an API definition file. To make a form request using these parameters, see Make a form request to edit an endpoint from an API definition file. Once you submit the POST request, to finish modifying the endpoint version, you need to take the response data and submit it as a request to the Edit a version operation.

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

contractId

string

The unique identifier for the contract under which to provision the endpoint.

groupId

integer

The unique identifier for the group under which to provision the endpoint.

importFileContent

string

The content of the API definition file encoded in Base64 (see RFC 4648 for details). Specify this only if you set the corresponding importFileSource to BODY_BASE64.

importFileFormat

string

enum

required

The format of the API definition file, either raml or swagger. You can import RAML 0.8 files and Swagger 2.0 or 3.0 files.

Allowed:

importFileSource

string

enum

required

The location of the API definition file, either URL if you store the file on the web, or BODY_BASE64 if you encode the file contents in the request body.

Allowed:

importUrl

string

The URL from which to get the API definition file. Specify this only if you set the corresponding importFileSource to URL.

root

string

If the import file located at the importUrl is a ZIP archive, this identifies the API definition's filename within the archive.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Operation succeeded.

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