Forge Object Store API for storing and retrieving objects
Deletes an object from the object store.
string
RequiredallOf [OsKeyRequestBody, object]
Object deleted successfully
1
2
3
4
5
6
7
8
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/forge/storage/os/v1/delete' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"cdn": true
}'Get the metadata for the specified object in the payload.
string
RequiredallOf [OsKeyRequestBody, object]
Metadata retrieved successfully
1
2
3
4
5
6
7
8
9
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/forge/storage/os/v1/metadata' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"cdn": true
}'1
2
3
4
5
6
7
{
"key": "<string>",
"checksum": "<string>",
"size": 2154,
"createdAt": "<string>",
"updatedAt": "<string>"
}Generates a pre-signed URL for uploading an object.
string
Requiredstring
Requiredinteger
Requiredstring
Requiredstring
Requiredinteger
boolean
boolean
Upload URL generated successfully
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/forge/storage/os/v1/upload-url' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"length": 2154,
"checksum": "<string>",
"checksumType": "SHA1",
"ttlSeconds": 2154,
"overwrite": true,
"cdn": true
}'1
2
3
{
"url": "<string>"
}Generates a pre-signed URL for downloading an object. This URL is intended for use within zero-trust compute environments.
string
RequiredallOf [OsKeyRequestBody, object]
Download URL generated successfully
1
2
3
4
5
6
7
8
9
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/forge/storage/os/v1/download-url' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"cdn": true
}'1
2
3
{
"url": "<string>"
}Generates a public pre-signed URL for uploading an object. This URL is intended for use in browsers and other public-facing contexts.
string
Requiredstring
Requiredinteger
Requiredstring
Requiredstring
Requiredinteger
boolean
boolean
Public upload URL generated successfully
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/forge/storage/os/v1/public-upload-url' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"length": 2154,
"checksum": "<string>",
"checksumType": "SHA1",
"ttlSeconds": 2154,
"overwrite": true,
"cdn": true
}'1
2
3
{
"url": "<string>"
}Generates a public pre-signed URL for downloading an object. This URL is intended for use in browsers and other public-facing contexts.
string
RequiredallOf [OsKeyRequestBody, object]
Public download URL generated successfully
1
2
3
4
5
6
7
8
9
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/forge/storage/os/v1/public-download-url' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"cdn": true
}'1
2
3
{
"url": "<string>"
}Generates a CDN URL for accessing an object with optional TTL. Defaults to 29 days.
string
RequiredallOf [OsKeyRequestBody, object]
CDN URL generated successfully
1
2
3
4
5
6
7
8
9
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/forge/storage/os/v1/cdn-url' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"ttlSeconds": 86
}'1
2
3
{
"url": "<string>"
}Rate this page: