Skip to content

Latest commit

 

History

History
298 lines (213 loc) · 10.1 KB

ResourceApi.md

File metadata and controls

298 lines (213 loc) · 10.1 KB
Raw

WebService::Fastly::ResourceApi

Load the API package

use WebService::Fastly::Object::ResourceApi;

Note

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

Method HTTP request Description
create_resource POST /service/{service_id}/version/{version_id}/resource Create a resource link
delete_resource DELETE /service/{service_id}/version/{version_id}/resource/{id} Delete a resource link
get_resource GET /service/{service_id}/version/{version_id}/resource/{id} Display a resource link
list_resources GET /service/{service_id}/version/{version_id}/resource List resource links
update_resource PUT /service/{service_id}/version/{version_id}/resource/{id} Update a resource link

create_resource

ResourceResponse create_resource(service_id => $service_id, version_id => $version_id, resource_id => $resource_id, name => $name)

Create a resource link

Create a link between a resource and a service version.

Example

use Data::Dumper;
use WebService::Fastly::ResourceApi;
my $api_instance = WebService::Fastly::ResourceApi->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 $resource_id = "resource_id_example"; # string | The ID of the underlying linked resource.
my $name = "name_example"; # string | The name of the resource link.

eval {
    my $result = $api_instance->create_resource(service_id => $service_id, version_id => $version_id, resource_id => $resource_id, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceApi->create_resource: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
resource_id string The ID of the underlying linked resource. [optional]
name string The name of the resource link. [optional]

Return type

ResourceResponse

Authorization

token

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]

delete_resource

InlineResponse200 delete_resource(service_id => $service_id, version_id => $version_id, id => $id)

Delete a resource link

Delete a link between a resource and a service version.

Example

use Data::Dumper;
use WebService::Fastly::ResourceApi;
my $api_instance = WebService::Fastly::ResourceApi->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 $id = "id_example"; # string | An alphanumeric string identifying the resource link.

eval {
    my $result = $api_instance->delete_resource(service_id => $service_id, version_id => $version_id, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceApi->delete_resource: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
id string An alphanumeric string identifying the resource link.

Return type

InlineResponse200

Authorization

token

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_resource

ResourceResponse get_resource(service_id => $service_id, version_id => $version_id, id => $id)

Display a resource link

Display a resource link by its identifier.

Example

use Data::Dumper;
use WebService::Fastly::ResourceApi;
my $api_instance = WebService::Fastly::ResourceApi->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 $id = "id_example"; # string | An alphanumeric string identifying the resource link.

eval {
    my $result = $api_instance->get_resource(service_id => $service_id, version_id => $version_id, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceApi->get_resource: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
id string An alphanumeric string identifying the resource link.

Return type

ResourceResponse

Authorization

token

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_resources

ARRAY[ResourceResponse] list_resources(service_id => $service_id, version_id => $version_id)

List resource links

List links between resources and services

Example

use Data::Dumper;
use WebService::Fastly::ResourceApi;
my $api_instance = WebService::Fastly::ResourceApi->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->list_resources(service_id => $service_id, version_id => $version_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceApi->list_resources: $@\n";
}

Parameters

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

Return type

ARRAY[ResourceResponse]

Authorization

token

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_resource

ResourceResponse update_resource(service_id => $service_id, version_id => $version_id, id => $id, resource_id => $resource_id, name => $name)

Update a resource link

Update a link between a resource and a service version.

Example

use Data::Dumper;
use WebService::Fastly::ResourceApi;
my $api_instance = WebService::Fastly::ResourceApi->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 $id = "id_example"; # string | An alphanumeric string identifying the resource link.
my $resource_id = "resource_id_example"; # string | The ID of the underlying linked resource.
my $name = "name_example"; # string | The name of the resource link.

eval {
    my $result = $api_instance->update_resource(service_id => $service_id, version_id => $version_id, id => $id, resource_id => $resource_id, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceApi->update_resource: $@\n";
}

Parameters

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int Integer identifying a service version.
id string An alphanumeric string identifying the resource link.
resource_id string The ID of the underlying linked resource. [optional]
name string The name of the resource link. [optional]

Return type

ResourceResponse

Authorization

token

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]