Organization API: Org Container Catalog

Every Organization API operation tagged Org Container Catalog.

View as Markdown

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/containers/catalog`	Browse platform + this org's specializations for versioned deploy UX
GET	`/api/v1/orgs/{org_slug}/containers/catalog/{slug}/compose`	Compose versions + recommended runtimes for an org-visible specialization

Browse platform + this org's specializations for versioned deploy UX

Section titled Browse platform + this org's specializations for versioned deploy UX

GET /api/v1/orgs/{org_slug}/containers/catalog

Browse platform + this org's specializations for versioned deploy UX.

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes
`category`	query	string or null	no

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].uuid`	string
`[].slug`	string or null
`[].name`	string
`[].description`	string or null
`[].runtime_template_slug`	string or null
`[].org_id`	integer or null
`[].default_variables`	object or null
`[].metadata`	object or null
`[].category`	string or null
`[].versioned`	boolean
`[].version_variable`	string or null
`[].version_source_slug`	string or null
`[].software_identifier`	string or null
`[].runtime_family`	string or null
`[].icon_url`	string or null
`[].color`	string or null
`[].group`	string or null
`[].deprecated`	boolean

Compose versions + recommended runtimes for an org-visible specialization

Section titled Compose versions + recommended runtimes for an org-visible specialization

GET /api/v1/orgs/{org_slug}/containers/catalog/{slug}/compose

Compose versions + recommended runtimes for an org-visible specialization.

Parameters

Section titled Parameters

Name	In	Type	Required	Description
`slug`	path	string	yes
`org_slug`	path	string	yes
`supported_only`	query	boolean	no	Default: `True`.
`include_snapshots`	query	boolean	no	Default: `False`.
`limit`	query	integer	no	Default: `200`.

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`slug`	string or null
`uuid`	string
`name`	string
`description`	string or null
`runtime_template_slug`	string or null
`default_variables`	object or null
`metadata`	object or null
`category`	string or null
`versioned`	boolean
`version_variable`	string or null
`version_source_slug`	string or null
`software_identifier`	string or null
`adapter_type`	string or null
`runtime_family`	string or null
`versions`	array of CatalogVersionOption
`versions[].version_id`	string
`versions[].name`	string
`versions[].release_date`	string or null
`versions[].supported`	boolean or null
`versions[].required_java`	integer or null
`versions[].build_number`	integer or null
`versions[].recommended_runtime_slug`	string or null
`versions[].recommended_runtime_uuid`	string or null
`versions[].recommended_runtime_name`	string or null
`versions[].game_versions`	array of string
`versions[].metadata`	object or null
`versions[].runtime_template_slug`	string or null
`versions[].runtime_template_uuid`	string or null
`runtime_versions`	array of CatalogVersionOption
`runtime_versions[].version_id`	string
`runtime_versions[].name`	string
`runtime_versions[].release_date`	string or null
`runtime_versions[].supported`	boolean or null
`runtime_versions[].required_java`	integer or null
`runtime_versions[].build_number`	integer or null
`runtime_versions[].recommended_runtime_slug`	string or null
`runtime_versions[].recommended_runtime_uuid`	string or null
`runtime_versions[].recommended_runtime_name`	string or null
`runtime_versions[].game_versions`	array of string
`runtime_versions[].metadata`	object or null
`runtime_versions[].runtime_template_slug`	string or null
`runtime_versions[].runtime_template_uuid`	string or null
`runtimes`	array of CatalogRuntimeOption
`runtimes[].uuid`	string
`runtimes[].slug`	string
`runtimes[].name`	string
`runtimes[].docker_image`	string or null
`runtimes[].description`	string or null
`defaults`	Defaults