Listing all setting of a tag¶

Sends a GET request to the endpoint /tags/{id}.

Description¶

The List-Tag-Settings request allows the user to request a list of all settings of a tag of the organisation.

Requirements¶

Values of the request: Tag-ID {id}d}

Objects: none

Request¶

To request a list of all settings of a tag, the Tag-ID {id} needs to be added to the path of the HTTP request.

As a result, the user gets one or more objects TagVO and TagAssignmentVO with the requested information.

The object TagVO provides the following information:

Attributes	Description	Values
`name`	The name of the tag.	`string`
`type`	The type of the tag.	`CACHE` `CONFIG` `RATE_LIMIT` `WAF` `Information`
`assignments`	An array of tag assignments.	`TagAssignmentVO`
`organizationId`	The ID of the organisation.	`integer`
`label`	A keyword for the tag.	`string`
`comment`	An individual comment for the entry.	`string`
`id`	The ID of the tag.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

The object TagAssignmentVO provides the following information:

Attributes	Description	Values
`type`	The type of the tag assignment.	`DOMAIN` `SUBDOMAIN`
`subDomainName`	The name of the subdomain, if the value of the attribute `type` is `SUBDOMAIN`.	`string`
`title`	The title of the tag assignment.	`string`
`comment`	An individual comment for the entry.	`string`
`id`	The ID of the tag assignment.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "objectType": "string",
    "name": "string",
    "type": "string",
    "global": true,
    "assignments": [
      {
        "objectType": "string",
        "type": "string",
        "subDomainName": "string",
        "title": "string",
        "id": 0,
        "modified": "string",
        "created": "string",
        "comment": "string"
      }
    ],
    "organizationId": 0,
    "sort": 0,
    "id": 0,
    "modified": "string",
    "created": "string",
    "comment": "string",
    "label": "string"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.