# Private Cloud › Managed VMware › Managed VMware vSphere › Logs API

> Part of the OVHcloud developer hub. Index of every page and section: https://developers.eu.ovhcloud.com/llms.txt
> The Private Cloud product's sections: https://developers.eu.ovhcloud.com/reference/private-cloud/llms.txt
> Everything in one file: https://developers.eu.ovhcloud.com/llms-full.txt

> 12 operations of the OVHcloud API. Calls carry `authorization: Bearer $OVH_TOKEN`; the EU host is shown, Canada and the United States answer on api.ca.ovhcloud.com and api.us.ovhcloud.com.

Page: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/

OpenAPI v1: https://api.eu.ovhcloud.com/v1/__schemas/developer-hub-navigation/private-cloud/managed-vmware/managed-vmware-vsphere/logs.json?format=openapi3
OpenAPI v2: https://api.eu.ovhcloud.com/v2/__schemas/developer-hub-navigation/private-cloud/managed-vmware/managed-vmware-vsphere/logs.json?format=openapi3

## Operations

- `GET /dedicatedCloud/{serviceName}/log/kind` — List log kinds
- `GET /dedicatedCloud/{serviceName}/log/kind/{name}` — Get a log kind
- `GET /dedicatedCloud/{serviceName}/log/subscription` — List log subscriptions
- `GET /dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}` — Get a log subscription
- `GET /dedicatedCloud/{serviceName}/logForwarder` — Get the log forwarder option
- `GET /dedicatedCloud/{serviceName}/logForwarder/canBeDisabled` — Check if log forwarding can be disabled
- `GET /dedicatedCloud/{serviceName}/logForwarder/canBeEnabled` — Check if log forwarding can be enabled
- `POST /dedicatedCloud/{serviceName}/log/subscription` — Create a log subscription
- `POST /dedicatedCloud/{serviceName}/log/url` — Generate a log URL
- `POST /dedicatedCloud/{serviceName}/logForwarder/disable` — Disable the log forwarder
- `POST /dedicatedCloud/{serviceName}/logForwarder/enable` — Enable the log forwarder
- `DELETE /dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}` — Delete a log subscription

## List log kinds

`GET /v1/dedicatedCloud/{serviceName}/log/kind`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#get-dedicatedcloud-servicename-log-kind

**Status:** Stable production version  
**IAM actions:** `pccVMware:apiovh:log/kind/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string[] | successful operation |

```json
[
  "string"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/log/kind" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicatedCloud/{serviceName}/log/kind")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicatedCloud/{serviceName}/log/kind");

print_r($result);
?>
```

## Get a log kind

`GET /v1/dedicatedCloud/{serviceName}/log/kind/{name}`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#get-dedicatedcloud-servicename-log-kind-name

**Status:** Stable production version  
**IAM actions:** `pccVMware:apiovh:log/kind/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `name` | path | string | yes | Log kind name |
| `serviceName` | path | string | yes | Domain of the service |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicatedCloud.ldpKind | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `additionalReturnedFields` | string[] | read-only | List of additional log fields managed in this log kind |
| `createdAt` | string (date-time) | read-only | Creation date of the log kind |
| `displayName` | string | read-only | Log kind display name |
| `kindId` | string (uuid) | read-only | Log kind ID |
| `name` | string | read-only | Log kind name |
| `updatedAt` | string (date-time) | read-only | Last update date of the log kind |

```json
{
  "additionalReturnedFields": [
    "string"
  ],
  "createdAt": "2024-01-01T12:00:00Z",
  "displayName": "string",
  "kindId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/log/kind/{name}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicatedCloud/{serviceName}/log/kind/{name}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicatedCloud/{serviceName}/log/kind/{name}");

print_r($result);
?>
```

## List log subscriptions

`GET /v1/dedicatedCloud/{serviceName}/log/subscription`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#get-dedicatedcloud-servicename-log-subscription

**Status:** Stable production version  
**IAM actions:** `pccVMware:apiovh:log/subscription/get`

List log subscriptions. Returns the IDs of the log subscriptions of the service. Filter by log kind with `kind`.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `kind` | query | string |  | Filter the value of kind property (=) |
| `serviceName` | path | string | yes | Domain of the service |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | string (uuid)[] | successful operation |

```json
[
  "00000000-0000-0000-0000-000000000000"
]
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/log/subscription" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicatedCloud/{serviceName}/log/subscription")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicatedCloud/{serviceName}/log/subscription");

print_r($result);
?>
```

## Get a log subscription

`GET /v1/dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#get-dedicatedcloud-servicename-log-subscription-subscriptionid

**Status:** Stable production version  
**IAM actions:** `pccVMware:apiovh:log/subscription/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |
| `subscriptionId` | path | string (uuid) | yes | Subscription ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicatedCloud.ldpSubscription | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdAt` | string (date-time) | read-only | Creation date of the subscription |
| `kind` | string | read-only | Log kind name of this subscription |
| `resource` | dedicatedCloud.LogSubscriptionResource | read-only | Subscribed resource, where the logs come from |
| `resource.name` | string |  | Name of subscribed resource |
| `resource.type` | string |  | Type of subscribed resource |
| `serviceName` | string | read-only | Name of the destination log service |
| `streamId` | string (uuid) | read-only | Id of the destination log stream |
| `subscriptionId` | string (uuid) | read-only | Subscription ID |
| `updatedAt` | string (date-time) | read-only | Last update date of the subscription |

```json
{
  "createdAt": "2024-01-01T12:00:00Z",
  "kind": "string",
  "resource": {
    "name": "string",
    "type": "string"
  },
  "serviceName": "string",
  "streamId": "00000000-0000-0000-0000-000000000000",
  "subscriptionId": "00000000-0000-0000-0000-000000000000",
  "updatedAt": "2024-01-01T12:00:00Z"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}");

print_r($result);
?>
```

## Get the log forwarder option

`GET /v1/dedicatedCloud/{serviceName}/logForwarder`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#get-dedicatedcloud-servicename-logforwarder

**Status:** Beta version  
**IAM actions:** `pccVMware:apiovh:logForwarder/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicatedCloud.LogForwarder | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | dedicatedCloud.option.StateEnum | read-only | State of the option — one of `disabled`, `disabling`, `enabled`, `enabling`, `error`, `migrating`, `unknown` |

```json
{
  "state": "disabled"
}
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/logForwarder" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicatedCloud/{serviceName}/logForwarder")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicatedCloud/{serviceName}/logForwarder");

print_r($result);
?>
```

## Check if log forwarding can be disabled

`GET /v1/dedicatedCloud/{serviceName}/logForwarder/canBeDisabled`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#get-dedicatedcloud-servicename-logforwarder-canbedisabled

**Status:** Beta version  
**IAM actions:** `pccVMware:apiovh:logForwarder/canBeDisabled/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | boolean | successful operation |

```json
true
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/logForwarder/canBeDisabled" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicatedCloud/{serviceName}/logForwarder/canBeDisabled")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicatedCloud/{serviceName}/logForwarder/canBeDisabled");

print_r($result);
?>
```

## Check if log forwarding can be enabled

`GET /v1/dedicatedCloud/{serviceName}/logForwarder/canBeEnabled`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#get-dedicatedcloud-servicename-logforwarder-canbeenabled

**Status:** Beta version  
**IAM actions:** `pccVMware:apiovh:logForwarder/canBeEnabled/get`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | boolean | successful operation |

```json
true
```

### Example

```bash
curl -X GET \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/logForwarder/canBeEnabled" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.get("/dedicatedCloud/{serviceName}/logForwarder/canBeEnabled")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->get("/dedicatedCloud/{serviceName}/logForwarder/canBeEnabled");

print_r($result);
?>
```

## Create a log subscription

`POST /v1/dedicatedCloud/{serviceName}/log/subscription`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#post-dedicatedcloud-servicename-log-subscription

**Status:** Stable production version  
**IAM actions:** `pccVMware:apiovh:log/subscription/create`, `ldp:apiovh:output/graylog/stream/forwardTo`

Create a log subscription. Sends the logs of a kind to a Logs Data Platform stream. The log forwarder option must be enabled first. Returns the operation ID.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | string | yes | Log kind name of the subscription |
| `streamId` | string (uuid) | yes | Id of the destination log stream |

```json
{
  "kind": "string",
  "streamId": "00000000-0000-0000-0000-000000000000"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicatedCloud.LogSubscriptionResponse | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `operationId` | string (uuid) |  | Identifier of the operation |
| `serviceName` | string |  | Operation owner's service name |

```json
{
  "operationId": "00000000-0000-0000-0000-000000000000",
  "serviceName": "string"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/log/subscription" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/dedicatedCloud/{serviceName}/log/subscription",
	kind = None, # Log kind name of the subscription (type: string)
	streamId = None, # Id of the destination log stream (type: uuid)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/dedicatedCloud/{serviceName}/log/subscription", array(
	kind => null, // Log kind name of the subscription (type: string)
	streamId => null, // Id of the destination log stream (type: uuid)
));

print_r($result);
?>
```

## Generate a log URL

`POST /v1/dedicatedCloud/{serviceName}/log/url`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#post-dedicatedcloud-servicename-log-url

**Status:** Stable production version  
**IAM actions:** `pccVMware:apiovh:log/url/create`

Generate a log URL. Returns a temporary URL to read the logs of a kind in real time, with its expiration date.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |

### Request body (required)

Type: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | string | yes | Log kinds for your dedicated cloud |

```json
{
  "kind": "string"
}
```

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicatedCloud.LogsURL | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `expirationDate` | string (date-time) |  | Expiration date |
| `url` | string |  | URL |

```json
{
  "expirationDate": "2024-01-01T12:00:00Z",
  "url": "string"
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/log/url" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN" \
  -H "content-type: application/json" \
  -d '{ }'
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

# Request body type: string
result = client.post("/dedicatedCloud/{serviceName}/log/url",
	kind = None, # Log kinds for your dedicated cloud (type: string)
)

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

// Request body type: string
$result = $ovh->post("/dedicatedCloud/{serviceName}/log/url", array(
	kind => null, // Log kinds for your dedicated cloud (type: string)
));

print_r($result);
?>
```

## Disable the log forwarder

`POST /v1/dedicatedCloud/{serviceName}/logForwarder/disable`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#post-dedicatedcloud-servicename-logforwarder-disable

**Status:** Beta version  
**IAM actions:** `pccVMware:apiovh:logForwarder/disable`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicatedCloud.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdBy` | string | read-only | Creator of the task |
| `createdFrom` | string | read-only | Origin of the task |
| `datacenterId` | integer | read-only | datacenterId of the associated dedicatedCloud.Datacenter object |
| `description` | string | read-only | Current progress description |
| `endDate` | string (date-time) | read-only | Task end date |
| `executionDate` | string (date-time) | read-only | Task execution date |
| `filerId` | integer | read-only | filerId of the associated dedicatedCloud.Filer object |
| `hostId` | integer | read-only | hostId of the associated dedicatedCloud.Host object |
| `lastModificationDate` | string (date-time) | read-only | Task last modification date |
| `maintenanceDateFrom` | string (date-time) | read-only | Maintenance task min allowed execution date |
| `maintenanceDateTo` | string (date-time) | read-only | Maintenance task max allowed execution date |
| `name` | string | read-only | Task name |
| `network` | string | read-only | network of the associated dedicatedCloud.Ip object |
| `networkAccessId` | integer | read-only | networkAccessId of the associated dedicatedCloud.AllowedNetwork object |
| `orderId` | integer | read-only | orderId of the associated billing.Order object |
| `parentTaskId` | integer | read-only | taskId of the parent dedicatedCloud.Task object |
| `progress` | integer | read-only | Current progress |
| `state` | dedicatedCloud.TaskStateEnum | read-only | Current Task state — one of `canceled`, `doing`, `done`, `error`, `fixing`, `toCancel`, `toCreate`, `todo`, `unknown`, `waitingForChilds`, `waitingTodo` |
| `taskId` | integer | read-only | Task id |
| `type` | string | read-only | Task type |
| `userId` | integer | read-only | userId of the associated dedicatedCloud.User object |
| `vlanId` | integer | read-only | vlanId of the parent dedicatedCloud.Vlan object |

```json
{
  "createdBy": "string",
  "createdFrom": "string",
  "datacenterId": 0,
  "description": "string",
  "endDate": "2024-01-01T12:00:00Z",
  "executionDate": "2024-01-01T12:00:00Z",
  "filerId": 0,
  "hostId": 0,
  "lastModificationDate": "2024-01-01T12:00:00Z",
  "maintenanceDateFrom": "2024-01-01T12:00:00Z",
  "maintenanceDateTo": "2024-01-01T12:00:00Z",
  "name": "string",
  "network": "string",
  "networkAccessId": 0,
  "orderId": 0,
  "parentTaskId": 0,
  "progress": 0,
  "state": "canceled",
  "taskId": 0,
  "type": "string",
  "userId": 0,
  "vlanId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/logForwarder/disable" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/dedicatedCloud/{serviceName}/logForwarder/disable")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/dedicatedCloud/{serviceName}/logForwarder/disable");

print_r($result);
?>
```

## Enable the log forwarder

`POST /v1/dedicatedCloud/{serviceName}/logForwarder/enable`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#post-dedicatedcloud-servicename-logforwarder-enable

**Status:** Beta version  
**IAM actions:** `pccVMware:apiovh:logForwarder/enable`

Enable the log forwarder. Enables the log forwarder option, required to create log subscriptions. Returns a task to track progress.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicatedCloud.Task | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `createdBy` | string | read-only | Creator of the task |
| `createdFrom` | string | read-only | Origin of the task |
| `datacenterId` | integer | read-only | datacenterId of the associated dedicatedCloud.Datacenter object |
| `description` | string | read-only | Current progress description |
| `endDate` | string (date-time) | read-only | Task end date |
| `executionDate` | string (date-time) | read-only | Task execution date |
| `filerId` | integer | read-only | filerId of the associated dedicatedCloud.Filer object |
| `hostId` | integer | read-only | hostId of the associated dedicatedCloud.Host object |
| `lastModificationDate` | string (date-time) | read-only | Task last modification date |
| `maintenanceDateFrom` | string (date-time) | read-only | Maintenance task min allowed execution date |
| `maintenanceDateTo` | string (date-time) | read-only | Maintenance task max allowed execution date |
| `name` | string | read-only | Task name |
| `network` | string | read-only | network of the associated dedicatedCloud.Ip object |
| `networkAccessId` | integer | read-only | networkAccessId of the associated dedicatedCloud.AllowedNetwork object |
| `orderId` | integer | read-only | orderId of the associated billing.Order object |
| `parentTaskId` | integer | read-only | taskId of the parent dedicatedCloud.Task object |
| `progress` | integer | read-only | Current progress |
| `state` | dedicatedCloud.TaskStateEnum | read-only | Current Task state — one of `canceled`, `doing`, `done`, `error`, `fixing`, `toCancel`, `toCreate`, `todo`, `unknown`, `waitingForChilds`, `waitingTodo` |
| `taskId` | integer | read-only | Task id |
| `type` | string | read-only | Task type |
| `userId` | integer | read-only | userId of the associated dedicatedCloud.User object |
| `vlanId` | integer | read-only | vlanId of the parent dedicatedCloud.Vlan object |

```json
{
  "createdBy": "string",
  "createdFrom": "string",
  "datacenterId": 0,
  "description": "string",
  "endDate": "2024-01-01T12:00:00Z",
  "executionDate": "2024-01-01T12:00:00Z",
  "filerId": 0,
  "hostId": 0,
  "lastModificationDate": "2024-01-01T12:00:00Z",
  "maintenanceDateFrom": "2024-01-01T12:00:00Z",
  "maintenanceDateTo": "2024-01-01T12:00:00Z",
  "name": "string",
  "network": "string",
  "networkAccessId": 0,
  "orderId": 0,
  "parentTaskId": 0,
  "progress": 0,
  "state": "canceled",
  "taskId": 0,
  "type": "string",
  "userId": 0,
  "vlanId": 0
}
```

### Example

```bash
curl -X POST \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/logForwarder/enable" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.post("/dedicatedCloud/{serviceName}/logForwarder/enable")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->post("/dedicatedCloud/{serviceName}/logForwarder/enable");

print_r($result);
?>
```

## Delete a log subscription

`DELETE /v1/dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}`

Link: https://developers.eu.ovhcloud.com/reference/private-cloud/managed-vmware/managed-vmware-vsphere/logs/#delete-dedicatedcloud-servicename-log-subscription-subscriptionid

**Status:** Stable production version  
**IAM actions:** `pccVMware:apiovh:log/subscription/delete`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `serviceName` | path | string | yes | Domain of the service |
| `subscriptionId` | path | string (uuid) | yes | Subscription ID |

### Responses

| Status | Type | Description |
| --- | --- | --- |
| 200 | dedicatedCloud.LogSubscriptionResponse | successful operation |

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `operationId` | string (uuid) |  | Identifier of the operation |
| `serviceName` | string |  | Operation owner's service name |

```json
{
  "operationId": "00000000-0000-0000-0000-000000000000",
  "serviceName": "string"
}
```

### Example

```bash
curl -X DELETE \
  "https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}" \
  -H "accept: application/json" \
  -H "authorization: Bearer $OVH_TOKEN"
```

```python
'''
First, install the latest release of Python wrapper: $ pip install ovh
'''
import json
import ovh

# Instantiate an OVH Client.
# You can generate new credentials with full access to your account on
# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
client = ovh.Client(
	endpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
	application_key='xxxxxxxxxx',    # Application Key
	application_secret='xxxxxxxxxx', # Application Secret
	consumer_key='xxxxxxxxxx',       # Consumer Key
)

result = client.delete("/dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}")

# Pretty print
print(json.dumps(result, indent=4))
```

```php
<?php
/**
 * First, download the latest release of PHP wrapper on github
 * And include this script into the folder with extracted files
 */
require __DIR__ . '/vendor/autoload.php';
use \Ovh\Api;

/**
 * Instantiate an OVH Client.
 * You can generate new credentials with full access to your account on
 * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)
 */
$ovh = new Api('xxxxxxxxxx',  // Application Key
               'xxxxxxxxxx',  // Application Secret
               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)
               'xxxxxxxxxx'); // Consumer Key

$result = $ovh->delete("/dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}");

print_r($result);
?>
```
