Create a signed URL to upload a file

Generate a pre-signed URL that can be used to upload a file to storage

post

Authorizations

user-internal

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

kindstring · enumRequiredPossible values:

Responses

201

Successfully generated signed URL for file upload

application/json

objectstring · enumRequired

The kind of file to upload

Possible values:

urlstring · uri · max: 2048Required

Presigned URL for uploading the file

keystringRequired

The bucket object key for the file

400

Bad Request

application/json

post/orgs/{organizationId}/storage/upload

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/storage/upload HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "file": {
    "name": "text",
    "type": "text",
    "size": 1
  },
  "kind": "customization_font"
}

{
  "object": "storage-signed-url",
  "url": "https://example.com",
  "key": "text"
}