For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tenant Tags

Tenant tag management operations

List tenant tags

get

Lists tags for a tenant

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
project_idstringRequired

The tenant ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
200

Tenant tags listed successfully

application/json
tagsstring[]Required
get/projects/{project_id}/tags
GET /keystone/v3/projects/{project_id}/tags HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*
{
  "tags": [
    "text"
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

Replace all tenant tags

put

Replaces all tags for a tenant

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
project_idstringRequired

The tenant ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Body
tagsstring[]Required
Responses
200

Tenant tags replaced successfully

application/json
tagsstring[]Required
put/projects/{project_id}/tags
PUT /keystone/v3/projects/{project_id}/tags HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "tags": [
    "text"
  ]
}
{
  "tags": [
    "text"
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

Delete all tenant tags

delete

Deletes all tags from a tenant

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
project_idstringRequired

The tenant ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
204

All tenant tags deleted successfully

No content

delete/projects/{project_id}/tags
DELETE /keystone/v3/projects/{project_id}/tags HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Add tag to tenant

put

Adds a tag to a tenant

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
project_idstringRequired

The tenant ID

tagstringRequired

The tag name

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
201

Tag added to tenant successfully

No content

put/projects/{project_id}/tags/{tag}
PUT /keystone/v3/projects/{project_id}/tags/{tag} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Remove tag from tenant

delete

Removes a tag from a tenant

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
project_idstringRequired

The tenant ID

tagstringRequired

The tag name

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
204

Tag removed from tenant successfully

No content

delete/projects/{project_id}/tags/{tag}
DELETE /keystone/v3/projects/{project_id}/tags/{tag} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Check if tenant has tag

head

Checks if a tenant has a specific tag

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
project_idstringRequired

The tenant ID

tagstringRequired

The tag name

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
204

Tenant has the tag

No content

head/projects/{project_id}/tags/{tag}
HEAD /keystone/v3/projects/{project_id}/tags/{tag} HTTP/1.1
Host: example.platform9.com
X-Auth-Token: text
Accept: */*

No content

Last updated

Was this helpful?