List Storage Credentials

Media API · Storage

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

Returns the list of Storage Credentials for this Storage instance. Any secret data will be sanitized in the response.

RBAC Capability Required: infra.storagetoken.get

Authentication

• Authorization header — Bearer authentication of the form Bearer <token>.

Path parameters

Example request

curl -X GET "https://app.mk.io/api/v1/projects/{project_name}/media/storage/{storage_name}/credentials" \
  -H "Authorization: Bearer <token>"

Responses

200 — A list of Storage Credentials

• @odata.nextLink · string · Optional — @odata.nextLink URL if the page length and number of items match.
• supplemental · object · Required — Supplemental info
  • 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 · object · Required — Pagination info
    • 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
  • subscription · object · Optional — Project info
    • id · string · Required — Project ID
    • name · string · Required — Project name
• value · list of objects · Required — A list of credentials
  • Array items (object):
    • metadata · object · Required — Metadata about the credential.
      • created · string · Optional · format: date-time — The time when the resource was created
      • createdBy · string · Optional · format: uuid — ID of the user who created the resource
      • createdByEmail · string · Optional — Email of the user who created the resource
      • id · string · Required · format: uuid — The ID of the resource
      • updated · string · Optional · format: date-time — The time when the resource was last updated
      • updatedBy · string · Optional · format: uuid — ID of the user who last updated the resource
      • updatedByEmail · string · Optional — Email of the user who last updated the resource
    • spec · object · Required — The specification of the credential.
      • One of the following variants, selected by type:
        • Microsoft.Storage (object)
          • credential · object · Required — The credential for the Azure Storage Account
            • sasToken · string · Required · pattern: ^?([a-z]+=[^&]+)(&[a-z]+=[^&]+)+$ — SAS Token for Azure Storage Account, including leading ?
            • signedExpiry · string · Required · format: date-time — The expiry time of the token.
            • signedStart · string or null · Required · format: date-time — The start time of the token.
          • type · enum or null · Required — The type of the credential.
            • Allowed values: Microsoft.Storage, AWS.S3, Google.Storage
        • AWS.S3 (object)
          • credential · object · Required — The credential for the AWS S3 bucket.
            • accessKeyId · string · Required · pattern: ^A[KS]IA[0-9A-Z]{16}$ — The access key ID for the bucket.
            • secretAccessKey · string · Required · pattern: ^[A-Za-z0-9+/=]{40}$ — The secret access key for the bucket.
          • type · enum or null · Required — The type of the credential.
            • Allowed values: Microsoft.Storage, AWS.S3, Google.Storage
        • Google.Storage (object)
          • credential · object · Required — The credential for the Google Storage bucket.
            • gac · map from strings 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.
              • [any key] · string — map of additional properties
          • type · enum or null · Required — The type of the credential.
            • Allowed values: Microsoft.Storage, AWS.S3, Google.Storage

Example:

{
  "@odata.nextLink": "string",
  "supplemental": {
    "count": 0,
    "kind": "string",
    "operation": "string",
    "pagination": {
      "end": 0,
      "records": 0,
      "start": 0,
      "total": 0
    },
    "subscription": {
      "id": "string",
      "name": "string"
    }
  },
  "value": [
    {
      "metadata": {
        "created": "2024-01-01T00:00:00Z",
        "createdBy": "00000000-0000-0000-0000-000000000000",
        "createdByEmail": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "updated": "2024-01-01T00:00:00Z",
        "updatedBy": "00000000-0000-0000-0000-000000000000",
        "updatedByEmail": "string"
      },
      "spec": {
        "type": "Microsoft.Storage",
        "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"
        }
      }
    }
  ]
}

400 — Bad Request

• error · object · Required — Pertinent information about the error
  • code · string · Required — The error code.
  • detail · string · Required — The error message.
  • extraDetail · map from strings to any · Optional — Extra information regarding this error.
    • [any key] · any — map of additional properties
• ref · string · Required — A reference to the request that caused the error.
• status · integer · Required — The HTTP status code

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

401 — Unauthorized

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

403 — Forbidden

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

404 — Not Found

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

429 — Too Many Requests

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

500 — Internal Server Error

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

Source spec: media-api · operationId: [get]_/api/v1/projects/{project_name}/media/storage/{storage_name}/credentials