Skip to content

Observability

All operations require authentication.

8 operationsv1 · v2/dedicated/server
Agent setup

List log kindsBeta

GET
/v2/dedicated/server/{serviceName}/log/kind

Returns the names of the log kinds Dedicated Servers emits, which can be forwarded to a stream.

Path parameters

serviceName
required
string

Service name

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200string[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/v2/dedicated/server/{serviceName}/log/kind \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

List log subscriptionsBeta

GET
/v2/dedicated/server/{serviceName}/log/subscription

Returns the identifiers of the Dedicated Servers log subscriptions. Set kind to restrict the list to one log kind.

Path parameters

serviceName
required
string

Service name

Query parameters

kind
string

Filter on a specific kind

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200string[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/v2/dedicated/server/{serviceName}/log/subscription \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "00000000-0000-0000-0000-000000000000"]

Get a log kindBeta

GET
/v2/dedicated/server/{serviceName}/log/kind/{name}

Returns a log kind and the additional fields its logs carry.

Path parameters

name
required
string

Name

serviceName
required
string

Service name

Response

200LogKindsuccessful operation
additionalReturnedFields
read-only
string[]

List of additional log fields managed in this log kind

createdAt
read-only
stringdate-time

Creation date of the log kind

displayName
read-only
string

Log kind display name

kindId
read-only
stringuuid

Identifier of the log kind

name
read-only
string

Log kind name

updatedAt
read-only
stringdate-time

Last update date of the log kind

Example uses name = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v2/dedicated/server/{serviceName}/log/kind/{name} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "additionalReturnedFields": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "displayName": "string", "kindId": "00000000-0000-0000-0000-000000000000", "name": "string", "updatedAt": "2024-01-01T12:00:00Z"}

Get a log subscriptionBeta

GET
/v2/dedicated/server/{serviceName}/log/subscription/{subscriptionId}

Returns the log kind and the destination stream of a subscription.

Path parameters

serviceName
required
string

Service name

subscriptionId
required
stringuuid

Subscription ID

Response

200LogSubscriptionsuccessful operation
createdAt
read-only
stringdate-time

Creation date of the subscription

kind
read-only
string

Log kind name of this subscription

resource
read-only
LogSubscriptionResource

Subscribed resource, where the logs come from

serviceName
read-only
string

Name of the destination log service

streamId
read-only
string

Identifier of the destination log stream

subscriptionId
read-only
stringuuid

Unique identifier of the subscription, used to change or stop the forwarding

updatedAt
read-only
stringdate-time

Last update date of the subscription

Example uses serviceName = string, subscriptionId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/dedicated/server/{serviceName}/log/subscription/{subscriptionId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "resource": { "name": "string", "type": "string" }, "serviceName": "string", "streamId": "string", "subscriptionId": "00000000-0000-0000-0000-000000000000", "updatedAt": "2024-01-01T12:00:00Z"}

Create a log subscriptionBeta

POST
/v2/dedicated/server/{serviceName}/log/subscription

Forwards Dedicated Servers logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier.

Path parameters

serviceName
required
string

Service name

Request body (required)

kind
required
string

Log kind name to subscribe to

streamId
required
stringuuid

Identifier of the customer log stream

Response

200LogSubscriptionResponsesuccessful operation
operationId
read-only
stringuuid

Identifier of the operation

serviceName
read-only
string

Operation owner's service name

400objectError 400 response
503objectError 503 response

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/v2/dedicated/server/{serviceName}/log/subscription \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}

Generate a temporary log URLBeta

POST
/v2/dedicated/server/{serviceName}/log/url

Generates a temporary URL to read the logs of one kind. The URL expires.

Path parameters

serviceName
required
string

Service name

Request body (required)

kind
required
string

Log kind name

Response

200TemporaryLogsLinksuccessful operation
expirationDate
read-only
stringdate-time

Temporary url expiration date

url
read-only
string

Temporary url

400objectError 400 response
503objectError 503 response

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/v2/dedicated/server/{serviceName}/log/url \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "expirationDate": "2024-01-01T12:00:00Z", "url": "string"}

Delete a log subscriptionBeta

DELETE
/v2/dedicated/server/{serviceName}/log/subscription/{subscriptionId}

Deletes the subscription and stops forwarding Dedicated Servers logs to the stream.

Path parameters

serviceName
required
string

Service name

subscriptionId
required
stringuuid

Subscription ID

Response

200LogSubscriptionResponsesuccessful operation
operationId
read-only
stringuuid

Identifier of the operation

serviceName
read-only
string

Operation owner's service name

Example uses serviceName = string, subscriptionId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/dedicated/server/{serviceName}/log/subscription/{subscriptionId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}

List public server logsDeprecated

GET
/1.0/dedicated/server/log

List public server logs. Returns public log entries for servers, page by page, optionally restricted to one server or one datacenter. Each entry gives the server name, a short text and a timestamp. This route is deprecated.

Query parameters

datacenter
DatacenterEnum

Restrict on the given datacenter

Valuesbhs1bhs2bhs3bhs4bhs5bhs6bhs7bhs8cch01crx1crx2dc1eri1eri2frcrx41frcrx42frcrx43gra04gra1gra2gra3gswhdf01hil1ieb01itbsi01itmil01itzvf01lil1-int1lim1lim2lim3mr901p19rbxrbx-hzrbx1rbx10rbx2rbx3rbx4rbx5rbx6rbx7rbx8rbx9sbg1sbg2sbg3sbg4sbg5sgp02sgp1syd03syd1syd2vin1waw1ynm1yyz01
limit
integer

Amount of rows per page

page
integer

Page to display

server
string

Restrict on the given server

Response

200PublicLogsuccessful operation
cacheDate
stringdate-time

Cache store timestamp

count
integer

Total amount of lines

data
PublicLogEntry[]

Logs

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/log \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "cacheDate": "2024-01-01T12:00:00Z", "count": 0, "data": [ { "datetime": "2024-01-01T12:00:00Z", "resume": "string", "server": "string" } ]}