Skip to content

Observability

All operations require authentication.

7 operationsv1/hosting/web
Agent setup

List log kindsBeta

GET
/1.0/hosting/web/{serviceName}/log/kind

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

Path parameters

serviceName
required
string

Service name

Response

200string[]successful operation

Example uses serviceName = string

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

List log subscriptionsBeta

GET
/1.0/hosting/web/{serviceName}/log/subscription

Returns the identifiers of the Web Hosting 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 (e.g., audit)

Response

200string[]successful operation

Example uses serviceName = string

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

Get a log kindBeta

GET
/1.0/hosting/web/{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

Log kind ID

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/1.0/hosting/web/{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
/1.0/hosting/web/{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
SubscriptionResource

Subscribed resource, where the logs come from

serviceName
read-only
string

Name of the destination log service

streamId
read-only
string

Id of the destination log stream

subscriptionId
read-only
stringuuid

Subscription ID

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/1.0/hosting/web/{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
/1.0/hosting/web/{serviceName}/log/subscription

Forwards Web Hosting 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

Customer log stream 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

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

Generate a temporary log URLBeta

POST
/1.0/hosting/web/{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

Example uses serviceName = string

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

Delete a log subscriptionBeta

DELETE
/1.0/hosting/web/{serviceName}/log/subscription/{subscriptionId}

Deletes the subscription and stops forwarding Web Hosting 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/1.0/hosting/web/{serviceName}/log/subscription/{subscriptionId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}