Secrets

PreviousAPI Keys NextUser

Last updated 2 months ago

Was this helpful?

List available secrets

get

List available secrets

Authorizations

Query parameters

secretTypeanyOptional

The type of the secret

Responses

objectOptional

get

GET /v1/auth/secrets HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "secrets": [
    {
      "id": "s3-secret",
      "secretType": "s3",
      "expiresAt": "2025-12-29T18:02:27.140Z",
      "accessKey": "AKIAIOSFODNN7EXAMPLE",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "name": "My S3 Secret"
    }
  ]
}

Remove a secret

delete

Remove a secret

Authorizations

Path parameters

secretTypeanyRequired

The type of the secret

idanyRequired

The ID of the secret

Responses

objectOptional

delete

DELETE /v1/auth/secrets/{secretType}/{id} HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "ok": true,
  "requestId": "text",
  "message": "text",
  "error": {
    "code": 1,
    "message": "text",
    "description": "text"
  }
}

Create or update a secret

post

Save a secret for data sources/destinations usage

Authorizations

Body

secretobjectRequired

secretKeystringRequired

Your data source's secret key.

Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Responses

objectOptional

post

POST /v1/auth/secrets HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "secret": {
    "id": "s3-secret",
    "secretType": "s3",
    "expiresAt": "2025-12-29T18:02:27.140Z",
    "accessKey": "AKIAIOSFODNN7EXAMPLE",
    "params": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "My S3 Secret"
  },
  "secretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}

{
  "ok": true,
  "requestId": "text",
  "message": "text",
  "error": {
    "code": 1,
    "message": "text",
    "description": "text"
  }
}