Skip to main content

Retrieve a resource tag

Contributors
PDFs

GET /resource-tags/{value}

Introduced In: 9.13

Retrieves a specific resource tag.

Parameters

Name Type In Required Description

value

string

path

True

  • format: key:value

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

num_resources

integer

The number of resources that are currently using this tag.

value

string

A key:value formatted string representing the tag's name.
Example response 
{
  "value": "team:accounting"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.