StarApi.md

Fastly\Api\StarApi

$apiInstance = new Fastly\Api\StarApi(
    // 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
createServiceStar()	POST /stars	Create a star
deleteServiceStar()	DELETE /stars/{star_id}	Delete a star
getServiceStar()	GET /stars/{star_id}	Get a star
listServiceStars()	GET /stars	List stars

createServiceStar()

createServiceStar($options): \Fastly\Model\StarResponse // Create a star

Create star.

Example

    $options['star'] = {"data":{"type":"star","relationships":{"user":{"data":{"type":"user","id":"6c7kAlo4vACNchGOdQxP37"}},"service":{"data":{"type":"service","id":"SU1Z0isxPaozGVKXdv0eY"}}}}}; // \Fastly\Model\Star

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

Options

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

Name	Type	Description	Notes
star	\Fastly\Model\Star		[optional]

Return type

\Fastly\Model\StarResponse

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

deleteServiceStar()

deleteServiceStar($options) // Delete a star

Delete star.

Example

    $options['star_id'] = 'star_id_example'; // string | Alphanumeric string identifying a star.

try {
    $apiInstance->deleteServiceStar($options);
} catch (Exception $e) {
    echo 'Exception when calling StarApi->deleteServiceStar: ', $e->getMessage(), PHP_EOL;
}

Options

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

Name	Type	Description	Notes
star_id	string	Alphanumeric string identifying a star.

Return type

void (empty response body)

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

getServiceStar()

getServiceStar($options): \Fastly\Model\StarResponse // Get a star

Show star.

Example

    $options['star_id'] = 'star_id_example'; // string | Alphanumeric string identifying a star.

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

Options

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

Name	Type	Description	Notes
star_id	string	Alphanumeric string identifying a star.

Return type

\Fastly\Model\StarResponse

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

listServiceStars()

listServiceStars($options): Pagination // List stars

List stars.

Example

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

Options

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

This endpoint does not need any parameters.

Return type

Pagination

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