Endpoint Storage

Get an Endpoint Storage

Retrieve an endpoint storage. The secret_access_key won't be displayed.

get/v1/storage/endpoint/{endpoint_name}

Request

Base URL: https://api.edgegap.com
URL: https://api.edgegap.com/v1/storage/endpoint/{endpoint_name}
Auth: API key in header authorization

Response

Success

namestring required

Name of the Endpoint Storage

access_key_idstring required

Your access key ID to connect to your S3 Bucket.

endpointstring required

Full URL to your S3 Bucket with https or http. It's recommended to not include your bucket name as a subdomain

bucketstring required

Your secret access key to connect to your S3 Bucket. Will be encrypted.

output_format'TEXT' | 'NDJSON'

The format how the logs will be exported to the bucket.

create_timestring

UTC time of endpoint storage creation

last_updatedstring

UTC time of endpoint storage last update

container_log_version'v1' | 'v2'

Log pipeline version (v1 or v2).

Example response

{
  "name": "my-s3-endpoint",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON",
  "create_time": "2022-01-01 00:00:00.000000",
  "last_updated": "2022-01-01 00:00:00.000000",
  "container_log_version": "v1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.