WWW::SwaggerClient::PinningApi

Load the API package

use WWW::SwaggerClient::Object::PinningApi;

All URIs are relative to https://api.estuary.tech

Method	HTTP request	Description
pinning_pins_get	GET /pinning/pins	List all pin status objects
pinning_pins_pinid_delete	DELETE /pinning/pins/{pinid}	Delete a pinned object
pinning_pins_pinid_get	GET /pinning/pins/{pinid}	Get a pin status object
pinning_pins_pinid_post	POST /pinning/pins/{pinid}	Replace a pinned object
pinning_pins_post	POST /pinning/pins	Add and pin object

pinning_pins_get

pinning_pins_get()

List all pin status objects

This endpoint lists all pin status objects

Example

use Data::Dumper;
use WWW::SwaggerClient::PinningApi;
my $api_instance = WWW::SwaggerClient::PinningApi->new(

    # Configure API key authorization: bearerAuth
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);


eval { 
    $api_instance->pinning_pins_get();
};
if ($@) {
    warn "Exception when calling PinningApi->pinning_pins_get: $@\n";
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

pinning_pins_pinid_delete

pinning_pins_pinid_delete(pinid => $pinid)

Delete a pinned object

This endpoint deletes a pinned object.

Example

use Data::Dumper;
use WWW::SwaggerClient::PinningApi;
my $api_instance = WWW::SwaggerClient::PinningApi->new(

    # Configure API key authorization: bearerAuth
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pinid = 'pinid_example'; # string | Pin ID

eval { 
    $api_instance->pinning_pins_pinid_delete(pinid => $pinid);
};
if ($@) {
    warn "Exception when calling PinningApi->pinning_pins_pinid_delete: $@\n";
}

Parameters

Name	Type	Description	Notes
pinid	string	Pin ID

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

pinning_pins_pinid_get

pinning_pins_pinid_get(pinid => $pinid)

Get a pin status object

This endpoint returns a pin status object.

Example

use Data::Dumper;
use WWW::SwaggerClient::PinningApi;
my $api_instance = WWW::SwaggerClient::PinningApi->new(

    # Configure API key authorization: bearerAuth
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pinid = 'pinid_example'; # string | cid

eval { 
    $api_instance->pinning_pins_pinid_get(pinid => $pinid);
};
if ($@) {
    warn "Exception when calling PinningApi->pinning_pins_pinid_get: $@\n";
}

Parameters

Name	Type	Description	Notes
pinid	string	cid

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

pinning_pins_pinid_post

pinning_pins_pinid_post(pinid => $pinid)

Replace a pinned object

This endpoint replaces a pinned object.

Example

use Data::Dumper;
use WWW::SwaggerClient::PinningApi;
my $api_instance = WWW::SwaggerClient::PinningApi->new(

    # Configure API key authorization: bearerAuth
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pinid = 'pinid_example'; # string | Pin ID

eval { 
    $api_instance->pinning_pins_pinid_post(pinid => $pinid);
};
if ($@) {
    warn "Exception when calling PinningApi->pinning_pins_pinid_post: $@\n";
}

Parameters

Name	Type	Description	Notes
pinid	string	Pin ID

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

pinning_pins_post

pinning_pins_post(cid => $cid, name => $name)

Add and pin object

This endpoint adds a pin to the IPFS daemon.

Example

use Data::Dumper;
use WWW::SwaggerClient::PinningApi;
my $api_instance = WWW::SwaggerClient::PinningApi->new(

    # Configure API key authorization: bearerAuth
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $cid = 'cid_example'; # string | cid
my $name = 'name_example'; # string | name

eval { 
    $api_instance->pinning_pins_post(cid => $cid, name => $name);
};
if ($@) {
    warn "Exception when calling PinningApi->pinning_pins_post: $@\n";
}

Parameters

Name	Type	Description	Notes
cid	string	cid
name	string	name

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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