WebService::Fastly::VersionApi
Load the API package
[!NOTE]
All URIs are relative to https://api.fastly.com
Method | HTTP request | Description ------ | ------------ | ----------- activate_service_version | PUT /service/{service_id}/version/{version_id}/activate | Activate a service version activate_service_version_environment | PUT /service/{service_id}/version/{version_id}/activate/{environment_name} | Activate a service version on the specified environment clone_service_version | PUT /service/{service_id}/version/{version_id}/clone | Clone a service version create_service_version | POST /service/{service_id}/version | Create a service version deactivate_service_version | PUT /service/{service_id}/version/{version_id}/deactivate | Deactivate a service version deactivate_service_version_environment | PUT /service/{service_id}/version/{version_id}/deactivate/{environment_name} | Deactivate a service version on an environment get_service_version | GET /service/{service_id}/version/{version_id} | Get a version of a service list_service_versions | GET /service/{service_id}/version | List versions of a service lock_service_version | PUT /service/{service_id}/version/{version_id}/lock | Lock a service version update_service_version | PUT /service/{service_id}/version/{version_id} | Update a service version validate_service_version | GET /service/{service_id}/version/{version_id}/validate | Validate a service version
activate_service_version
VersionResponse activate_service_version(service_id => $service_id, version_id => $version_id)
Activate a service version
Activate the current version.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
eval
{
my
$result
=
$api_instance
->activate_service_version(
service_id
=>
$service_id
,
version_id
=>
$version_id
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->activate_service_version: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
activate_service_version_environment
VersionResponse activate_service_version_environment(service_id => $service_id, version_id => $version_id, environment_name => $environment_name)
Activate a service version on the specified environment
Activate a version on a given environment, i.e. "staging"
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
my
$environment_name
= new WebService::Fastly.EnvironmentName();
# EnvironmentName |
eval
{
my
$result
=
$api_instance
->activate_service_version_environment(
service_id
=>
$service_id
,
version_id
=>
$version_id
,
environment_name
=>
$environment_name
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->activate_service_version_environment: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. | environment_name | EnvironmentName| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
clone_service_version
Version clone_service_version(service_id => $service_id, version_id => $version_id)
Clone a service version
Clone the current configuration into a new version.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
eval
{
my
$result
=
$api_instance
->clone_service_version(
service_id
=>
$service_id
,
version_id
=>
$version_id
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->clone_service_version: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_service_version
VersionCreateResponse create_service_version(service_id => $service_id)
Create a service version
Create a version for a particular service.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
eval
{
my
$result
=
$api_instance
->create_service_version(
service_id
=>
$service_id
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->create_service_version: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deactivate_service_version
VersionResponse deactivate_service_version(service_id => $service_id, version_id => $version_id)
Deactivate a service version
Deactivate the current version.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
eval
{
my
$result
=
$api_instance
->deactivate_service_version(
service_id
=>
$service_id
,
version_id
=>
$version_id
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->deactivate_service_version: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deactivate_service_version_environment
VersionResponse deactivate_service_version_environment(service_id => $service_id, version_id => $version_id, environment_name => $environment_name)
Deactivate a service version on an environment
Deactivate the current version on a given environment, i.e. "staging"
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
my
$environment_name
= new WebService::Fastly.EnvironmentName();
# EnvironmentName |
eval
{
my
$result
=
$api_instance
->deactivate_service_version_environment(
service_id
=>
$service_id
,
version_id
=>
$version_id
,
environment_name
=>
$environment_name
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->deactivate_service_version_environment: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. | environment_name | EnvironmentName| |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_service_version
VersionResponse get_service_version(service_id => $service_id, version_id => $version_id)
Get a version of a service
Get the version for a particular service.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
eval
{
my
$result
=
$api_instance
->get_service_version(
service_id
=>
$service_id
,
version_id
=>
$version_id
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->get_service_version: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list_service_versions
ARRAY[VersionResponse] list_service_versions(service_id => $service_id)
List versions of a service
List the versions for a particular service.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
eval
{
my
$result
=
$api_instance
->list_service_versions(
service_id
=>
$service_id
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->list_service_versions: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
lock_service_version
Version lock_service_version(service_id => $service_id, version_id => $version_id)
Lock a service version
Locks the specified version.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
eval
{
my
$result
=
$api_instance
->lock_service_version(
service_id
=>
$service_id
,
version_id
=>
$version_id
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->lock_service_version: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_service_version
VersionResponse update_service_version(service_id => $service_id, version_id => $version_id, active => $active, comment => $comment, deployed => $deployed, locked => $locked, number => $number, staging => $staging, testing => $testing)
Update a service version
Update a particular version for a particular service.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
my
$active
= false;
# boolean | Whether this is the active version or not.
my
$comment
=
"comment_example"
;
# string | A freeform descriptive note.
my
$deployed
= null;
# boolean | Unused at this time.
my
$locked
= false;
# boolean | Whether this version is locked or not. Objects can not be added or edited on locked versions.
my
$number
= 56;
# int | The number of this version.
my
$staging
= false;
# boolean | Unused at this time.
my
$testing
= false;
# boolean | Unused at this time.
eval
{
my
$result
=
$api_instance
->update_service_version(
service_id
=>
$service_id
,
version_id
=>
$version_id
,
active
=>
$active
,
comment
=>
$comment
,
deployed
=>
$deployed
,
locked
=>
$locked
,
number
=>
$number
,
staging
=>
$staging
,
testing
=>
$testing
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->update_service_version: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. | active | boolean| Whether this is the active version or not. | [optional] [default to false] comment | string| A freeform descriptive note. | [optional] deployed | boolean| Unused at this time. | [optional] locked | boolean| Whether this version is locked or not. Objects can not be added or edited on locked versions. | [optional] [default to false] number | int| The number of this version. | [optional] staging | boolean| Unused at this time. | [optional] [default to false] testing | boolean| Unused at this time. | [optional] [default to false]
Return type
Authorization
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
validate_service_version
InlineResponse200 validate_service_version(service_id => $service_id, version_id => $version_id)
Validate a service version
Validate the version for a particular service and version.
Example
use
Data::Dumper;
my
$api_instance
= WebService::Fastly::VersionApi->new(
# Configure API key authorization: token
api_key
=> {
'Fastly-Key'
=>
'YOUR_API_KEY'
},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my
$service_id
=
"service_id_example"
;
# string | Alphanumeric string identifying the service.
my
$version_id
= 56;
# int | Integer identifying a service version.
eval
{
my
$result
=
$api_instance
->validate_service_version(
service_id
=>
$service_id
,
version_id
=>
$version_id
);
Dumper(
$result
);
};
if
($@) {
warn
"Exception when calling VersionApi->validate_service_version: $@\n"
;
}
Parameters
Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]