This section shows you how to update an endpoint from an API definition file by submitting a multipart/form-data
request (see RFC 2388 for details). If instead you'd like to submit an application/json
request to update an endpoint, see Make a JSON request to edit an endpoint from an API definition file.
-
If you don't already have an
apiEndpointId
value, run the List endpoints operation. -
Select the appropriate endpoint from the returned array and store its
apiEndpointId
value. -
If you don't already have a
versionNumber
value, run the List versions operation. -
Select the appropriate endpoint version from the returned array and store its
versionNumber
value. -
Prepare an API definition file and set the
importFileFormat
toraml
orswagger
. -
Assign the filename as the
importFile
. -
Optionally embed the API definition within a ZIP archive, in which case reset the definition filename as
root
and the name of the archive asimportFile
. -
Optionally make the definition or archive file available on the web at an
importUrl
. -
Prepare a
multipart/form-data
request specifying the fields listed in Parameters. Specify either animportFile
orimportUrl
, and make sure to specify theroot
if you're uploading a ZIP archive. -
Make a form data POST request to
/api-definitions/v2/endpoints/{apiEndPointId}/versions/{versionNumber}/file?force=true
.
A 200 response confirms success, and the response object reflects your modifications.