Organizations

Create an API Contract

Create a Contract between the Client and an API. In order to create a Contract, the caller must specify the Organization, ID, and Version of the API.Additionally, the caller must specify the ID of the plan it wants to use for the contract with the API.

post/organizations/{organizationId}/clients/{clientId}/versions/{version}/contracts

Request

  • Base URL: https://apiman.io/apiman
  • URL: https://apiman.io/apiman/organizations/{organizationId}/clients/{clientId}/versions/{version}/contracts
  • Auth: none declared

Path parameters

organizationIdstring required

The Organization ID.

clientIdstring required

The Client ID.

versionstring required

The Client version.

Request body

apiOrgIdstring
apiIdstring
apiVersionstring
planIdstring

Response

If the Contract is successfully created.

idinteger
createdBystring
createdOnstring date-time
status'AwaitingApproval' | 'Created' | 'Rejected'

Changes

No recorded changes to this operation across all 1 revision of this API.