Skip to content

SecretStoreItemApi.md

Latest commit

 

History

History
258 lines (191 loc) · 7.33 KB

SecretStoreItemApi.md

File metadata and controls

258 lines (191 loc) · 7.33 KB

Fastly::SecretStoreItemApi

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

Methods

Note

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

Method HTTP request Description
create_secret POST /resources/stores/secret/{store_id}/secrets Create a new secret in a store.
delete_secret DELETE /resources/stores/secret/{store_id}/secrets/{secret_name} Delete a secret from a store.
get_secret GET /resources/stores/secret/{store_id}/secrets/{secret_name} Get secret metadata.
get_secrets GET /resources/stores/secret/{store_id}/secrets List secrets within a store.
must_recreate_secret PATCH /resources/stores/secret/{store_id}/secrets Recreate a secret in a store.
recreate_secret PUT /resources/stores/secret/{store_id}/secrets Create or recreate a secret in a store.

create_secret()

create_secret(opts): <SecretResponse> # Create a new secret in a store.

Create a new secret in a store. Returns an error if a secret already exists with the same name. See PUT and PATCH methods for ways to recreate an existing secret. The secret field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is "Hello, world!"

Examples

api_instance = Fastly::SecretStoreItemApi.new
opts = {
    store_id: 'store_id_example', # String | 
    secret: Fastly::Secret.new, # Secret | 
}

begin
  # Create a new secret in a store.
  result = api_instance.create_secret(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling SecretStoreItemApi->create_secret: #{e}"
end

Options

Name Type Description Notes
store_id String
secret Secret [optional]

Return type

SecretResponse

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

delete_secret()

delete_secret(opts) # Delete a secret from a store.

Delete a secret from a store by name.

Examples

api_instance = Fastly::SecretStoreItemApi.new
opts = {
    store_id: 'store_id_example', # String | 
    secret_name: 'secret_name_example', # String | 
}

begin
  # Delete a secret from a store.
  api_instance.delete_secret(opts)
rescue Fastly::ApiError => e
  puts "Error when calling SecretStoreItemApi->delete_secret: #{e}"
end

Options

Name Type Description Notes
store_id String
secret_name String

Return type

nil (empty response body)

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

get_secret()

get_secret(opts): <SecretResponse> # Get secret metadata.

Get metadata about a secret by name.

Examples

api_instance = Fastly::SecretStoreItemApi.new
opts = {
    store_id: 'store_id_example', # String | 
    secret_name: 'secret_name_example', # String | 
}

begin
  # Get secret metadata.
  result = api_instance.get_secret(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling SecretStoreItemApi->get_secret: #{e}"
end

Options

Name Type Description Notes
store_id String
secret_name String

Return type

SecretResponse

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

get_secrets()

get_secrets(opts): <InlineResponse20013> # List secrets within a store.

List all secrets within a store.

Examples

api_instance = Fastly::SecretStoreItemApi.new
opts = {
    store_id: 'store_id_example', # String | 
    cursor: 'cursor_example', # String | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
    limit: 'limit_example', # String | Number of results per page. The maximum is 200.
}

begin
  # List secrets within a store.
  result = api_instance.get_secrets(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling SecretStoreItemApi->get_secrets: #{e}"
end

Options

Name Type Description Notes
store_id String
cursor String Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty. [optional]
limit String Number of results per page. The maximum is 200. [optional][default to '100']

Return type

InlineResponse20013

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

must_recreate_secret()

must_recreate_secret(opts): <SecretResponse> # Recreate a secret in a store.

Recreate a secret based on the secret's name. Returns an error if there is no existing secret with the same name. The secret field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is "Hello, world!"

Examples

api_instance = Fastly::SecretStoreItemApi.new
opts = {
    store_id: 'store_id_example', # String | 
    secret: Fastly::Secret.new, # Secret | 
}

begin
  # Recreate a secret in a store.
  result = api_instance.must_recreate_secret(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling SecretStoreItemApi->must_recreate_secret: #{e}"
end

Options

Name Type Description Notes
store_id String
secret Secret [optional]

Return type

SecretResponse

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

recreate_secret()

recreate_secret(opts): <SecretResponse> # Create or recreate a secret in a store.

Create or recreate a secret based on the secret's name. The response object's recreated field will be true if the secret was recreated. The secret field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is "Hello, world!"

Examples

api_instance = Fastly::SecretStoreItemApi.new
opts = {
    store_id: 'store_id_example', # String | 
    secret: Fastly::Secret.new, # Secret | 
}

begin
  # Create or recreate a secret in a store.
  result = api_instance.recreate_secret(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling SecretStoreItemApi->recreate_secret: #{e}"
end

Options

Name Type Description Notes
store_id String
secret Secret [optional]

Return type

SecretResponse

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