Create storage provider

Create a new storage provider for the organization.

Processing mode: sync

POST /orgs/{organization}/storage-providers

Create storage provider

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/storage-providers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'region' => '<string>',
    'bucket' => '<string>',
    'directory' => '<string>',
    'endpoint' => '<string>',
    'access_key' => '<string>',
    'secret_key' => '<string>',
    'assume_role' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

201

{
  "data": {
    "id": "<string>",
    "type": "storageProviders",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "attributes": {
      "name": "<string>",
      "provider": "s3",
      "provider_name": "Amazon S3",
      "region": "<string>",
      "bucket": "<string>",
      "directory": "<string>",
      "endpoint": "<string>",
      "assume_role": true,
      "in_use": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

storage:manage

Allow members to manage the organization's storage providers.

Path Parameters

organization · string · required

The organization slug

Body

application/json

name · string · required

Maximum string length: 255

provider · enum<string> · required

Available options: s3, spaces, hetzner, ovh, scaleway, custom

region · string

bucket · string | null

directory · string | null

endpoint · string<uri>

access_key · string | null

secret_key · string | null

assume_role · boolean

Response

201

application/vnd.api+json

StorageProviderResource

data · StorageProviderResource · object · required

Show child attributes