Fastly\Api\VclApi

$apiInstance = new Fastly\Api\VclApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

Methods

Note

All URIs are relative to https://api.fastly.com

Method	HTTP request	Description
createCustomVcl()	POST /service/{service_id}/version/{version_id}/vcl	Create a custom VCL file
deleteCustomVcl()	DELETE /service/{service_id}/version/{version_id}/vcl/{vcl_name}	Delete a custom VCL file
getCustomVcl()	GET /service/{service_id}/version/{version_id}/vcl/{vcl_name}	Get a custom VCL file
getCustomVclBoilerplate()	GET /service/{service_id}/version/{version_id}/boilerplate	Get boilerplate VCL
getCustomVclGenerated()	GET /service/{service_id}/version/{version_id}/generated_vcl	Get the generated VCL for a service
getCustomVclGeneratedHighlighted()	GET /service/{service_id}/version/{version_id}/generated_vcl/content	Get the generated VCL with syntax highlighting
getCustomVclHighlighted()	GET /service/{service_id}/version/{version_id}/vcl/{vcl_name}/content	Get a custom VCL file with syntax highlighting
getCustomVclRaw()	GET /service/{service_id}/version/{version_id}/vcl/{vcl_name}/download	Download a custom VCL file
lintVclDefault()	POST /vcl_lint	Lint (validate) VCL using a default set of flags.
lintVclForService()	POST /service/{service_id}/lint	Lint (validate) VCL using flags set for the service.
listCustomVcl()	GET /service/{service_id}/version/{version_id}/vcl	List custom VCL files
setCustomVclMain()	PUT /service/{service_id}/version/{version_id}/vcl/{vcl_name}/main	Set a custom VCL file as main
updateCustomVcl()	PUT /service/{service_id}/version/{version_id}/vcl/{vcl_name}	Update a custom VCL file

`createCustomVcl()`

createCustomVcl($options): \Fastly\Model\VclResponse // Create a custom VCL file

Upload a VCL for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['content'] = 'content_example'; // string | The VCL code to be included.
$options['main'] = True; // bool | Set to `true` when this is the main VCL, otherwise `false`.
$options['name'] = 'name_example'; // string | The name of this VCL.

try {
    $result = $apiInstance->createCustomVcl($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->createCustomVcl: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
content	string	The VCL code to be included.	[optional]
main	bool	Set to `true` when this is the main VCL, otherwise `false`.	[optional]
name	string	The name of this VCL.	[optional]

Return type

\Fastly\Model\VclResponse

[Back to top] [Back to API list] [Back to README]

`deleteCustomVcl()`

deleteCustomVcl($options): \Fastly\Model\InlineResponse200 // Delete a custom VCL file

Delete the uploaded VCL for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['vcl_name'] = 'vcl_name_example'; // string | The name of this VCL.

try {
    $result = $apiInstance->deleteCustomVcl($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->deleteCustomVcl: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
vcl_name	string	The name of this VCL.

Return type

\Fastly\Model\InlineResponse200

[Back to top] [Back to API list] [Back to README]

`getCustomVcl()`

getCustomVcl($options): \Fastly\Model\VclResponse // Get a custom VCL file

Get the uploaded VCL for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['vcl_name'] = 'vcl_name_example'; // string | The name of this VCL.
$options['no_content'] = '0'; // string | Omit VCL content.

try {
    $result = $apiInstance->getCustomVcl($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->getCustomVcl: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
vcl_name	string	The name of this VCL.
no_content	string	Omit VCL content.	[optional] [defaults to '0']

Return type

\Fastly\Model\VclResponse

[Back to top] [Back to API list] [Back to README]

`getCustomVclBoilerplate()`

getCustomVclBoilerplate($options): string // Get boilerplate VCL

Return boilerplate VCL with the service's TTL from the settings.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.

try {
    $result = $apiInstance->getCustomVclBoilerplate($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->getCustomVclBoilerplate: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.

Return type

string

[Back to top] [Back to API list] [Back to README]

`getCustomVclGenerated()`

getCustomVclGenerated($options): \Fastly\Model\VclResponse // Get the generated VCL for a service

Display the generated VCL for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.

try {
    $result = $apiInstance->getCustomVclGenerated($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->getCustomVclGenerated: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.

Return type

\Fastly\Model\VclResponse

[Back to top] [Back to API list] [Back to README]

`getCustomVclGeneratedHighlighted()`

getCustomVclGeneratedHighlighted($options): \Fastly\Model\VclSyntaxHighlightingResponse // Get the generated VCL with syntax highlighting

Display the content of generated VCL with HTML syntax highlighting. Include line numbers by sending lineno=true as a request parameter.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.

try {
    $result = $apiInstance->getCustomVclGeneratedHighlighted($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->getCustomVclGeneratedHighlighted: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.

Return type

\Fastly\Model\VclSyntaxHighlightingResponse

[Back to top] [Back to API list] [Back to README]

`getCustomVclHighlighted()`

getCustomVclHighlighted($options): \Fastly\Model\VclSyntaxHighlightingResponse // Get a custom VCL file with syntax highlighting

Get the uploaded VCL for a particular service and version with HTML syntax highlighting. Include line numbers by sending lineno=true as a request parameter.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['vcl_name'] = 'vcl_name_example'; // string | The name of this VCL.

try {
    $result = $apiInstance->getCustomVclHighlighted($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->getCustomVclHighlighted: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
vcl_name	string	The name of this VCL.

Return type

\Fastly\Model\VclSyntaxHighlightingResponse

[Back to top] [Back to API list] [Back to README]

`getCustomVclRaw()`

getCustomVclRaw($options): string // Download a custom VCL file

Download the specified VCL.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['vcl_name'] = 'vcl_name_example'; // string | The name of this VCL.

try {
    $result = $apiInstance->getCustomVclRaw($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->getCustomVclRaw: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
vcl_name	string	The name of this VCL.

Return type

string

[Back to top] [Back to API list] [Back to README]

`lintVclDefault()`

lintVclDefault($options): \Fastly\Model\ValidatorResult // Lint (validate) VCL using a default set of flags.

This endpoint validates the submitted VCL against a default set of enabled flags. Consider using the /service/{service_id}/lint operation to validate VCL in the context of a specific service.

Example

    $options['inline_object1'] = new \Fastly\Model\InlineObject1(); // \Fastly\Model\InlineObject1

try {
    $result = $apiInstance->lintVclDefault($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->lintVclDefault: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
inline_object1	\Fastly\Model\InlineObject1

Return type

\Fastly\Model\ValidatorResult

[Back to top] [Back to API list] [Back to README]

`lintVclForService()`

lintVclForService($options): \Fastly\Model\ValidatorResult // Lint (validate) VCL using flags set for the service.

Services may have flags set by a Fastly employee or by the purchase of products as addons to the service, which modify the way VCL is interpreted by that service. This endpoint validates the submitted VCL in the context of the specified service.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['inline_object'] = new \Fastly\Model\InlineObject(); // \Fastly\Model\InlineObject

try {
    $result = $apiInstance->lintVclForService($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->lintVclForService: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
inline_object	\Fastly\Model\InlineObject

Return type

\Fastly\Model\ValidatorResult

[Back to top] [Back to API list] [Back to README]

`listCustomVcl()`

listCustomVcl($options): \Fastly\Model\VclResponse[] // List custom VCL files

List the uploaded VCLs for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.

try {
    $result = $apiInstance->listCustomVcl($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->listCustomVcl: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.

Return type

\Fastly\Model\VclResponse[]

[Back to top] [Back to API list] [Back to README]

`setCustomVclMain()`

setCustomVclMain($options): \Fastly\Model\VclResponse // Set a custom VCL file as main

Set the specified VCL as the main.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['vcl_name'] = 'vcl_name_example'; // string | The name of this VCL.

try {
    $result = $apiInstance->setCustomVclMain($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->setCustomVclMain: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
vcl_name	string	The name of this VCL.

Return type

\Fastly\Model\VclResponse

[Back to top] [Back to API list] [Back to README]

`updateCustomVcl()`

updateCustomVcl($options): \Fastly\Model\VclResponse // Update a custom VCL file

Update the uploaded VCL for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['vcl_name'] = 'vcl_name_example'; // string | The name of this VCL.
$options['content'] = 'content_example'; // string | The VCL code to be included.
$options['main'] = True; // bool | Set to `true` when this is the main VCL, otherwise `false`.
$options['name'] = 'name_example'; // string | The name of this VCL.

try {
    $result = $apiInstance->updateCustomVcl($options);
} catch (Exception $e) {
    echo 'Exception when calling VclApi->updateCustomVcl: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name	Type	Description	Notes
service_id	string	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
vcl_name	string	The name of this VCL.
content	string	The VCL code to be included.	[optional]
main	bool	Set to `true` when this is the main VCL, otherwise `false`.	[optional]
name	string	The name of this VCL.	[optional]

Return type

\Fastly\Model\VclResponse

[Back to top] [Back to API list] [Back to README]

Files

VclApi.md

Latest commit

History

VclApi.md

File metadata and controls

Fastly\Api\VclApi

Methods

createCustomVcl()

Example

Options

Return type

deleteCustomVcl()

Example

Options

Return type

getCustomVcl()

Example

Options

Return type

getCustomVclBoilerplate()

Example

Options

Return type

getCustomVclGenerated()

Example

Options

Return type

getCustomVclGeneratedHighlighted()

Example

Options

Return type

getCustomVclHighlighted()

Example

Options

Return type

getCustomVclRaw()

Example

Options

Return type

lintVclDefault()

Example

Options

Return type

lintVclForService()

Example

Options

Return type

listCustomVcl()

Example

Options

Return type

setCustomVclMain()

Example

Options

Return type

updateCustomVcl()

Example

Options

Return type

`createCustomVcl()`

`deleteCustomVcl()`

`getCustomVcl()`

`getCustomVclBoilerplate()`

`getCustomVclGenerated()`

`getCustomVclGeneratedHighlighted()`

`getCustomVclHighlighted()`

`getCustomVclRaw()`

`lintVclDefault()`

`lintVclForService()`

`listCustomVcl()`

`setCustomVclMain()`

`updateCustomVcl()`