Skip to content

SnapshotEventsApi.md

Latest commit

 

History

History
85 lines (55 loc) · 2.53 KB

SnapshotEventsApi.md

File metadata and controls

85 lines (55 loc) · 2.53 KB

hyperstack.SnapshotEventsApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method HTTP request Description
list_snapshot_events GET /core/snapshots/{snapshot_id}/events Fetch all events for a snapshot

list_snapshot_events

list_snapshot_events(snapshot_id)

Fetch all events for a snapshot

Retrieves a list of all events for a Snapshot's history, which records actions performed on the specific snapshot. Requires the snapshot ID in the path.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.SnapshotEventsApi(api_client)
    snapshot_id = 56 # int | 

    try:
        # Fetch all events for a snapshot
        api_instance.list_snapshot_events(snapshot_id)
    except Exception as e:
        print("Exception when calling SnapshotEventsApi->list_snapshot_events: %s\n" % e)

Parameters

Name Type Description Notes
snapshot_id int

Return type

void (empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Success -

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