Skip to content

metrics_access_token

Manage /metrics endpoint access tokens

Create

Path
POST /v7.0/metrics_access_tokens
Description
Create a new access token
Authentication required
yes
Scope
metrics_access_token#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
metrics_access_token
ParameterTypeRequiredDetails
user
User
 Resource no
metric_prefix
Metric prefix
 String no

Prefix added to all metrics

Default: vpsadmin_

Validation rules
RuleDetails
Length
  • Maximum length: 30 characters (inclusive).

Validation error message: length must be at most 30

Format

Must match this regular expression:

\A[a-zA-Z_]+\z

null

Validation error message: only allows letters and underscore

Output parameters

Layout
object
Namespace
metrics_access_token
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
access_token
Access token
 String
metric_prefix
Metric prefix
 String Prefix added to all metrics
use_count
Use count
 Integer
last_use
Last use
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/metrics_access_tokens/{metrics_access_token_id}
Description
Delete access token
Authentication required
yes
Scope
metrics_access_token#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/metrics_access_tokens
Description
Authentication required
yes
Scope
metrics_access_token#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
metrics_access_token
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
user
User
 Resource no

Output parameters

Layout
object_list
Namespace
metrics_access_tokens
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
access_token
Access token
 String
metric_prefix
Metric prefix
 String Prefix added to all metrics
use_count
Use count
 Integer
last_use
Last use
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/metrics_access_tokens/{metrics_access_token_id}
Description
Authentication required
yes
Scope
metrics_access_token#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
metrics_access_token
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
access_token
Access token
 String
metric_prefix
Metric prefix
 String Prefix added to all metrics
use_count
Use count
 Integer
last_use
Last use
 Datetime
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime