Endpoint Storage

Update an Endpoint Storage

Update an Endpoint Storage with new specifications.

patch/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

Request body

namestring

Name of the Endpoint Storage

access_key_idstring

Your access key ID to connect to your S3 Bucket.

endpointstring

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

bucketstring

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 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

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

Example request

{
  "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",
  "container_log_version": "v1",
  "secret_access_key": "my-secret-access"
}

Response

Success

namestring

Name of the Endpoint Storage

access_key_idstring

Your access key ID to connect to your S3 Bucket.

endpointstring

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

bucketstring

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 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 storage creation

last_updatedstring

UTC time of endpoint storage last update

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",
  "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.