StarApi.md

Fastly::StarApi

require 'fastly'
api_instance = Fastly::StarApi.new

Methods

Note

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

Method	HTTP request	Description
create_service_star	POST /stars	Create a star
delete_service_star	DELETE /stars/{star_id}	Delete a star
get_service_star	GET /stars/{star_id}	Get a star
list_service_stars	GET /stars	List stars

create_service_star()

create_service_star(opts): <StarResponse> # Create a star

Create star.

Examples

api_instance = Fastly::StarApi.new
opts = {
    star: Fastly::Star.new, # Star | 
}

begin
  # Create a star
  result = api_instance.create_service_star(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling StarApi->create_service_star: #{e}"
end

Options

Name	Type	Description	Notes
star	Star		[optional]

Return type

StarResponse

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

delete_service_star()

delete_service_star(opts) # Delete a star

Delete star.

Examples

api_instance = Fastly::StarApi.new
opts = {
    star_id: 'star_id_example', # String | Alphanumeric string identifying a star.
}

begin
  # Delete a star
  api_instance.delete_service_star(opts)
rescue Fastly::ApiError => e
  puts "Error when calling StarApi->delete_service_star: #{e}"
end

Options

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

Return type

nil (empty response body)

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

get_service_star()

get_service_star(opts): <StarResponse> # Get a star

Show star.

Examples

api_instance = Fastly::StarApi.new
opts = {
    star_id: 'star_id_example', # String | Alphanumeric string identifying a star.
}

begin
  # Get a star
  result = api_instance.get_service_star(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling StarApi->get_service_star: #{e}"
end

Options

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

Return type

StarResponse

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

list_service_stars()

list_service_stars: <Pagination> # List stars

List stars.

Examples

api_instance = Fastly::StarApi.new

begin
  # List stars
  result = api_instance.list_service_stars
  p result
rescue Fastly::ApiError => e
  puts "Error when calling StarApi->list_service_stars: #{e}"
end

Options

This endpoint does not need any parameter.

Return type

Pagination

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