Catalog

Import Catalog Entry

Changed on

Enqueue an async import of a catalog entry into the local registry.

post/catalog/{api_id}:import

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /catalog/{api_id}:import
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Path parameters

api_idstring required

Catalog identity of the API (domain[/sub-api]); send any / unencoded.

Example:stripe.com

Response

Successful Response

job_idstring required

ID of the import job.

statusstring required

Status of the job when accepted; queued.

Example response

{
  "_links": {
    "self": "https://jentic.example.com/jobs/job_6968b3985e8c9902207afaeb"
  },
  "job_id": "job_6968b3985e8c9902207afaeb",
  "status": "queued"
}

Changes