> This page is for mk.io.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# List Storage instances

GET https://app.mk.io/api/v1/projects/{project_name}/media/storage

## Listing, Sorting and Filtering Storage Instances

This endpoint returns the list of storage instances in the specified project.

### Sorting

The results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas
where each one can optionally specify `asc` or `desc`.

Sorting is valid on the following fields: `created`, `createdBy`, `id`, `name`, `privateLinkServiceConnectionStatus`, `type`, `updated`, `updatedBy`, `url`

### Filtering



The `$filter` query parameter allows for storage instances to be filtered on the basis of fields in the schema using OData query syntax.
See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used.

Filters are valid on the following fields: `cloud/name`, `cloud/region/name`, `created`, `createdBy`, `createdByEmail`, `createdByName`, `id`, `name`, `privateLinkServiceConnectionStatus`, `region`, `type`, `updated`, `updatedBy`, `updatedByEmail`, `updatedByName`, `url`

### Examples:

`?$top=10` - Returns only the first 10 storage instances from the list.

`?$orderby=name desc` - Sorts storage instances by name in descending order.

`?$filter=name eq 'descriptive name'` - Returns storage instances that match the provided name.


`?$orderby=created desc` - Sorts storage instances by creation date in descending order.

`?$filter=created ge 2021-01-01T00:00:00Z` - Returns storage instances created after January 1, 2021.

RBAC Capability Required: `infra.storage.get`

Reference: https://mediakind.ferndocs.com/mkio/api/media/storage/list-storage-instances

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `project_name` (string, required)

### Query parameters

- `$orderby` (string, optional) — Specifies the key by which the result collection should be ordered.
- `$filter` (string, optional) — Restricts the set of items returned.
- `$top` (string, optional) — Specifies a non-negative integer `n` that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value `n`.
- `$skiptoken` (string, optional) — Specifies a start offset to support paginated results. Use `@odata.nextLink` in the result object to enumerate the collection - it will be present only if there's more than one page of entities.

## Response

### 200

A list of Storage instances

- `supplemental` (ListResponseSupplementalSchema, required) — Supplemental info
- `value` (list of StorageSchemaGet, required) — List of storage instances.
- `@odata.nextLink` (string, optional) — @odata.nextLink URL if the page length and number of items match.

## Errors

### 400 Bad Request Error

Bad Request

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 401 Unauthorized Error

Unauthorized

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 403 Forbidden Error

Forbidden

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 404 Not Found Error

Not Found

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 429 Too Many Requests Error

Too Many Requests

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 500 Internal Server Error

Internal Server Error

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

## Types

### ListResponseSupplementalSchema

- `count` (integer, required) — Number of items returned
- `kind` (string, required) — Type of items in the list
- `operation` (string, required) — Operation type. Should always say 'list'
- `pagination` (PaginationInfoSchema, required) — Pagination info
- `subscription` (ProjectInfoSchema, optional) — Project info

### StorageSchemaGet

- `metadata` (BlobStorageMetadataSchema, required) — Metadata about the storage instance.
- `spec` (StorageSchemaGetSpec, required) — The specification of the storage instance.
- `kind` (string, optional) — The kind of record.
- `status` (StorageStatusRead, optional) — Additional status information regarding the storage instance.

### ErrorDetail

- `code` (string, required) — The error code.
- `detail` (string, required) — The error message.
- `extraDetail` (map from string to any, optional) — Extra information regarding this error.

### PaginationInfoSchema

- `end` (integer, required) — Position of the last item in the list
- `records` (integer, required) — Total number of items returned in the list
- `start` (integer, required) — Position of the first item in the list
- `total` (integer, required) — Total number of items in the project

### ProjectInfoSchema

- `id` (string, required) — Project ID
- `name` (string, required) — Project name

### BlobStorageMetadataSchema

- `id` (string, required) — The ID of the resource
- `created` (datetime, optional) — The time when the resource was created
- `createdBy` (string, optional) — ID of the user who created the resource
- `createdByEmail` (string, optional) — Email of the user who created the resource
- `name` (string, optional) — The name of the resource
- `updated` (datetime, optional) — The time when the resource was last updated
- `updatedBy` (string, optional) — ID of the user who last updated the resource
- `updatedByEmail` (string, optional) — Email of the user who last updated the resource

### StorageSchemaGetSpec

The specification of the storage instance.

- `type`: `AWS.S3` (AWSStorageSpecRead)
  - `bucketName` (string, required) — The name of the AWS S3 bucket. This field cannot be modified, only set during creation.
  - `description` (string, required, nullable) — Description of the storage.
  - `region` (string, required, nullable) — Storage region.
  - `url` (string, required) — The URL of the S3 bucket
  - `credential` (AWSCredential, optional) — The credential for the AWS S3 bucket. Required at creation.
- `type`: `Google.Storage` (GoogleStorageSpecRead)
  - `bucketName` (string, required) — The name of the Google Storage bucket. This field cannot be modified, only set during creation.
  - `description` (string, required, nullable) — Description of the storage.
  - `region` (string, required, nullable) — Storage region.
  - `credential` (GoogleCredential, optional) — The credential for the Google Storage bucket. Required at creation.
- `type`: `Microsoft.Storage` (AzureStorageSpecRead)
  - `description` (string, required, nullable) — Description of the storage.
  - `region` (string, required, nullable) — Storage region.
  - `url` (string, required) — HTTP(S) URL required for access to the storage. This field cannot be modified, only set during creation.
  - `credential` (AzureCredentialRead, optional) — The credential for the Azure Storage Account
  - `privateLinkServiceConnection` (PrivateLinkServiceConnectionNullable, optional) — Optional settings for a Private Link. Set it to null to remove the Private Link.

### StorageStatusRead

- `activeCredentialId` (string, required, nullable) — The ID of the active credential for this storage.
- `privateLinkServiceConnectionStatus` (enum, optional) — The state of the Azure Private Connection, if enabled.
  - Allowed values: `Creating`, `Pending`, `Ready`, `Running`, `Deleting`, `Deleted`

### AWSCredential

- `accessKeyId` (string, required) — The access key ID for the bucket.
- `secretAccessKey` (string, required) — The secret access key for the bucket.

### GoogleCredential

- `gac` (map from string to string, required) — Google Application Credentials in JSON format.\ You can generate this from the command line with `gcloud iam service-accounts keys create key.json --iam-account=<service_account>@<project>.iam.gserviceaccount.com`\ Or download it from the GCP console.

### AzureCredentialRead

- `sasToken` (string, required) — SAS Token for Azure Storage Account, including leading ?
- `signedExpiry` (datetime, required) — The expiry time of the token.
- `signedStart` (datetime, required, nullable) — The start time of the token.

### PrivateLinkServiceConnectionNullable

- `requestMessage` (string, required) — A message passed to the owner of the remote resource with this connection request. This field cannot be modified, only set during creation.
- `resourceGroupName` (string, required) — The name of the resource group containing the storage account This field cannot be modified, only set during creation.
- `storageAccountName` (string, required) — The name of the storage account. The full Azure ID would be '/subscriptions/\{subscriptionId}/resourceGroups/\{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/\{storageAccountName}' This field cannot be modified, only set during creation.
- `subscriptionId` (string, required) — The ID of the Azure subscription containing the storage account This field cannot be modified, only set during creation.

## Examples

**Response**

```json
{
  "supplemental": {
    "count": 1,
    "kind": "string",
    "operation": "string",
    "pagination": {
      "end": 1,
      "records": 1,
      "start": 1,
      "total": 1
    },
    "subscription": {
      "id": "string",
      "name": "string"
    }
  },
  "value": [
    {
      "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"
      }
    }
  ],
  "@odata.nextLink": "string"
}
```

**SDK Code**

```python
import requests

url = "https://app.mk.io/api/v1/projects/project_name/media/storage"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/v1/projects/project_name/media/storage';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mk.io/api/v1/projects/project_name/media/storage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.mk.io/api/v1/projects/project_name/media/storage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.mk.io/api/v1/projects/project_name/media/storage")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.mk.io/api/v1/projects/project_name/media/storage', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/media/storage");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/media/storage")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```