Endpoint Storage

Create a New Pull Profile

Create a pull profile. Pull profile will upload data from an endpoint storage to a deployment container on boot. You must link the application version to the pull profile first.

post/v1/storage/endpoint/{endpoint_name}/pull-profile

Request

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

Request body

namestring required

Name of the pull profile

sourcestring required

Source in the S3 bucket to fetch from

source_type'File' | 'Folder' required

If the source is a File or a Directory

destinationstring required

Destination path where your source will be uploaded in your container. Make sure to avoid protected destinations, such as /etc/, as this will prevent the files from being copied to your deployment, and will make your deployment fail. Make sure a normal user can write to the destination folder.

Example request

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs"
}

Response

Success

namestring required

Name of the pull profile

sourcestring required

Source in the S3 bucket to fetch from

source_type'File' | 'Folder' required

If the source is a File or a Directory

destinationstring required

create_timestring

UTC time of pull profile creation

last_updatedstring

UTC time of pull profile last update

Example response

{
  "name": "pull_profile_name",
  "source": "/my-bucket/config.cfg",
  "source_type": "File",
  "destination": "/usr/share/configs",
  "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.