API

Make a JSON request to edit an endpoint from an API definition file

This section shows you how to update an endpoint from an API definition file by submitting an application/json request. If instead you'd like to submit a multipart/form-data request to update an endpoint, see Make a form request to edit an endpoint from an API definition file.

  1. If you don't already have an apiEndpointId value, run the List endpoints operation.

  2. Select the appropriate endpoint from the returned array and store its apiEndpointId value.

  3. If you don't already have a versionNumber value, run the List versions operation.

  4. Select the appropriate endpoint version from the returned array and store its versionNumber value.

  5. Build an ImportFile object, specifying the importFileFormat and importFileSource. Depending on the importFileSource, specify either the importFileContent or importUrl.

  6. POST the object to /api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/file.

A 200 response confirms success, and the response object reflects your modifications.