Create or Update Storage instance

PUT

https://app.mk.io/api/v1/projects/:project_name/media/storage/:storage_name

PUT

/api/v1/projects/:project_name/media/storage/:storage_name

curl -X PUT https://app.mk.io/api/v1/projects/project_name/media/storage/storage_name \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "spec": {
    "type": "AWS.S3",
    "bucketName": "my-aws-bucket",
    "credential": {
      "accessKeyId": "AKIAEXAMPLE123456789",
      "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
      "sasToken": "?sv=2022-11-02&ss=bfqt&srt=co&sp=rwdlacupiyx&se=2024-11-12T00:05:04Z&st=2024-11-11T16:05:04Z&spr=https&sig=<redacted>"
    },
    "description": "Input media files for processing.",
    "url": "https://blobsamples.blob.core.windows.net/"
  }
}'

{
  "metadata": {
    "id": "string",
    "created": "2024-01-15T09:30:00Z",
    "createdBy": "string",
    "createdByEmail": "string",
    "name": "string",
    "updated": "2024-01-15T09:30:00Z",
    "updatedBy": "string",
    "updatedByEmail": "string"
  },
  "spec": {
    "type": "Microsoft.Storage",
    "description": "Input media files for processing.",
    "region": "string",
    "url": "https://blobsamples.blob.core.windows.net/",
    "credential": {
      "sasToken": "?sv=2022-11-02&ss=bfqt&srt=co&sp=rwdlacupiyx&se=2024-11-12T00:05:04Z&st=2024-11-11T16:05:04Z&spr=https&sig=<redacted>",
      "signedExpiry": "2024-11-12T00:05:04Z",
      "signedStart": "2024-11-11T16:05:04Z"
    },
    "privateLinkServiceConnection": {
      "requestMessage": "string",
      "resourceGroupName": "string",
      "storageAccountName": "string",
      "subscriptionId": "string"
    }
  },
  "kind": "string",
  "status": {
    "activeCredentialId": "string",
    "privateLinkServiceConnectionStatus": "Creating"
  }
}

Create or update a Storage instance. Only the description, credentials and privateLinkServiceConnection details are updatable.

RBAC Capability Required: infra.storage.create or infra.storage.update

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_namestringRequired

storage_namestringRequired

Request

This endpoint expects an object.

specobjectRequired

The specification of the storage instance.

Response

Storage instance successfully updated

metadataobject

Metadata about the storage instance.

specobject

The specification of the storage instance.

kindstringOptionalRead-only

The kind of record.

statusobjectOptional

Additional status information regarding the storage instance.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error