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

This section shows you how to create 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 create an endpoint, see Make a form request to register an endpoint from an API definition file.

  1. If you don't already have the obligatory contractId and groupId members, run the List contracts and groups operation.

  2. Select the appropriate pairing of contract and group under which you want to provision the new endpoint. Store the contractId and groupId values.

  3. Build an ImportFile object, specifying the contractId and groupId members, the importFileFormat, and the importFileSource. Depending on the importFileSource, specify either the importFileContent or importUrl.

  4. POST the object to /api-definitions/v2/endpoints/files.

The response Endpoint object reflects the newly created endpoint based on your API definition file. You can access the newly created endpoint at the URL specified in the Location response header.