Skip to content

Latest commit

 

History

History
441 lines (314 loc) · 15.4 KB

VersionApi.md

File metadata and controls

441 lines (314 loc) · 15.4 KB
Raw

Fastly\Api\VersionApi

$apiInstance = new Fastly\Api\VersionApi(
    // 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
activateServiceVersion() PUT /service/{service_id}/version/{version_id}/activate Activate a service version
activateServiceVersionEnvironment() PUT /service/{service_id}/version/{version_id}/activate/{environment_name} Activate a service version on the specified environment
cloneServiceVersion() PUT /service/{service_id}/version/{version_id}/clone Clone a service version
createServiceVersion() POST /service/{service_id}/version Create a service version
deactivateServiceVersion() PUT /service/{service_id}/version/{version_id}/deactivate Deactivate a service version
deactivateServiceVersionEnvironment() PUT /service/{service_id}/version/{version_id}/deactivate/{environment_name} Deactivate a service version on an environment
getServiceVersion() GET /service/{service_id}/version/{version_id} Get a version of a service
listServiceVersions() GET /service/{service_id}/version List versions of a service
lockServiceVersion() PUT /service/{service_id}/version/{version_id}/lock Lock a service version
updateServiceVersion() PUT /service/{service_id}/version/{version_id} Update a service version
validateServiceVersion() GET /service/{service_id}/version/{version_id}/validate Validate a service version

activateServiceVersion()

activateServiceVersion($options): \Fastly\Model\VersionResponse // Activate a service version

Activate the current 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->activateServiceVersion($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->activateServiceVersion: ', $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\VersionResponse

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

activateServiceVersionEnvironment()

activateServiceVersionEnvironment($options): \Fastly\Model\VersionResponse // Activate a service version on the specified environment

Activate a version on a given environment, i.e. "staging"

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['environment_name'] = new \Fastly\Model\\Fastly\Model\EnvironmentName(); // \Fastly\Model\EnvironmentName

try {
    $result = $apiInstance->activateServiceVersionEnvironment($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->activateServiceVersionEnvironment: ', $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.
environment_name \Fastly\Model\EnvironmentName

Return type

\Fastly\Model\VersionResponse

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

cloneServiceVersion()

cloneServiceVersion($options): \Fastly\Model\Version // Clone a service version

Clone the current configuration into a new 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->cloneServiceVersion($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->cloneServiceVersion: ', $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\Version

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

createServiceVersion()

createServiceVersion($options): \Fastly\Model\VersionCreateResponse // Create a service version

Create a version for a particular service.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.

try {
    $result = $apiInstance->createServiceVersion($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->createServiceVersion: ', $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.

Return type

\Fastly\Model\VersionCreateResponse

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

deactivateServiceVersion()

deactivateServiceVersion($options): \Fastly\Model\VersionResponse // Deactivate a service version

Deactivate the current 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->deactivateServiceVersion($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->deactivateServiceVersion: ', $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\VersionResponse

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

deactivateServiceVersionEnvironment()

deactivateServiceVersionEnvironment($options): \Fastly\Model\VersionResponse // Deactivate a service version on an environment

Deactivate the current version on a given environment, i.e. "staging"

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['environment_name'] = new \Fastly\Model\\Fastly\Model\EnvironmentName(); // \Fastly\Model\EnvironmentName

try {
    $result = $apiInstance->deactivateServiceVersionEnvironment($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->deactivateServiceVersionEnvironment: ', $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.
environment_name \Fastly\Model\EnvironmentName

Return type

\Fastly\Model\VersionResponse

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

getServiceVersion()

getServiceVersion($options): \Fastly\Model\VersionResponse // Get a version of a service

Get the version for a particular service.

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->getServiceVersion($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->getServiceVersion: ', $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\VersionResponse

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

listServiceVersions()

listServiceVersions($options): \Fastly\Model\VersionResponse[] // List versions of a service

List the versions for a particular service.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.

try {
    $result = $apiInstance->listServiceVersions($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->listServiceVersions: ', $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.

Return type

\Fastly\Model\VersionResponse[]

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

lockServiceVersion()

lockServiceVersion($options): \Fastly\Model\Version // Lock a service version

Locks the specified 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->lockServiceVersion($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->lockServiceVersion: ', $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\Version

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

updateServiceVersion()

updateServiceVersion($options): \Fastly\Model\VersionResponse // Update a service version

Update a particular version for a particular service.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['active'] = false; // bool | Whether this is the active version or not.
$options['comment'] = 'comment_example'; // string | A freeform descriptive note.
$options['deployed'] = True; // bool | Unused at this time.
$options['locked'] = false; // bool | Whether this version is locked or not. Objects can not be added or edited on locked versions.
$options['number'] = 56; // int | The number of this version.
$options['staging'] = false; // bool | Unused at this time.
$options['testing'] = false; // bool | Unused at this time.

try {
    $result = $apiInstance->updateServiceVersion($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->updateServiceVersion: ', $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.
active bool Whether this is the active version or not. [optional] [defaults to false]
comment string A freeform descriptive note. [optional]
deployed bool Unused at this time. [optional]
locked bool Whether this version is locked or not. Objects can not be added or edited on locked versions. [optional] [defaults to false]
number int The number of this version. [optional]
staging bool Unused at this time. [optional] [defaults to false]
testing bool Unused at this time. [optional] [defaults to false]

Return type

\Fastly\Model\VersionResponse

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

validateServiceVersion()

validateServiceVersion($options): \Fastly\Model\InlineResponse200 // Validate a service version

Validate the version 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->validateServiceVersion($options);
} catch (Exception $e) {
    echo 'Exception when calling VersionApi->validateServiceVersion: ', $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\InlineResponse200

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