Organization API: Resource Tags

Every Organization API operation tagged Resource Tags.

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}/tags/sources/{source_type}/{source_id}`	Get org resource tags
POST	`/api/v1/orgs/{org_slug}/tags/sources/{source_type}/{source_id}`	Add org resource tag
PUT	`/api/v1/orgs/{org_slug}/tags/sources/{source_type}/{source_id}`	Replace org resource tags
DELETE	`/api/v1/orgs/{org_slug}/tags/sources/{source_type}/{source_id}/{tag}`	Remove org resource tag
GET	`/api/v1/orgs/{org_slug}/tags/vocabulary`	List org tag vocabulary

Get org resource tags

Section titled Get org resource tags

GET /api/v1/orgs/{org_slug}/tags/sources/{source_type}/{source_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`source_type`	path	string	yes
`source_id`	path	string	yes
`org_slug`	path	string	yes

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
`source_type`	string
`source_id`	string
`tags`	array of string

Add org resource tag

Section titled Add org resource tag

POST /api/v1/orgs/{org_slug}/tags/sources/{source_type}/{source_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`source_type`	path	string	yes
`source_id`	path	string	yes
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`tag`	string	yes

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
`tags`	array of string

Replace org resource tags

Section titled Replace org resource tags

PUT /api/v1/orgs/{org_slug}/tags/sources/{source_type}/{source_id}

Parameters

Section titled Parameters

Name	In	Type	Required
`source_type`	path	string	yes
`source_id`	path	string	yes
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`tags`	array of string	no

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
`tags`	array of string

Remove org resource tag

Section titled Remove org resource tag

DELETE /api/v1/orgs/{org_slug}/tags/sources/{source_type}/{source_id}/{tag}

Parameters

Section titled Parameters

Name	In	Type	Required
`source_type`	path	string	yes
`source_id`	path	string	yes
`tag`	path	string	yes
`org_slug`	path	string	yes

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
`tags`	array of string

List org tag vocabulary

Section titled List org tag vocabulary

GET /api/v1/orgs/{org_slug}/tags/vocabulary

Parameters

Section titled Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`source_type`	query	string	yes	e.g. org_service, vps, container_server

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
`items`	array of TagVocabularyItem
`items[].tag`	string
`items[].resource_count`	integer
`source_type`	string or null