Portal Artifacts Generation

Download Generated Portal Artifacts

GET
/portal-artifacts/{id}/download

Download the generated Portal Artifacts as a zip file. The zip file contains:

  1. sdk/<language>.zip: the SDK for each configured language
  2. code-samples/<language>.json: the code samples catalog for each configured language
  3. docs/<language>.json: the getting started guide for each configured language
  4. plugin.zip: the context plugin, only when the build input declares one

The artifacts are available only after generation completes. Until then, this endpoint returns 400.

Authorization

Authorization
Authorization<token>

Auth Header. Provide your Auth key in the format X-Auth-Key {auth-key}.

In: header

Path Parameters

id*string

The id returned by Generate Portal Artifacts Async.

Formatuuid

Response Body

application/zip

application/json

application/json

application/json

curl -X GET "https://example.com/portal-artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/download"
"string"