Endpoint Storage

Create a New Endpoint Storage

Create an endpoint storage to store your container logs at the end of a deployment.

post/v1/storage/endpoint

Request

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

Request body

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.

container_log_version'v1' | 'v2'

Log pipeline version. v1 (default) stores a single file per deployment at the end of the run. v2 uses a streaming pipeline that writes chunked logs to S3 in real time.

secret_access_keystring required

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

Example request

{
  "name": "my-s3-bucket",
  "access_key_id": "my-access-key-id",
  "endpoint": "https://us-east-1.your-s3-provider.com",
  "bucket": "my-bucket",
  "output_format": "NDJSON",
  "container_log_version": "v1",
  "secret_access_key": "my-secret-access"
}

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.

container_log_version'v1' | 'v2'

Log pipeline version. v1 (default) stores a single file per deployment at the end of the run. v2 uses a streaming pipeline that writes chunked logs to S3 in real time.

create_timestring

UTC time of endpoint creation

last_updatedstring

UTC time of endpoint last update

Example response

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

Changes

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