Secrets

PreviousAPI Keys NextUser

Last updated 1 month ago

Was this helpful?

List available secrets

get

List available secrets

Authorizations

Query parameters

secretTypeanyoptional

The type of the secret

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://api.bytenite.com/v1/auth/secrets' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

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

A successful response.

Remove a secret

delete

Remove a secret

Authorizations

Path parameters

secretTypeanyrequired

The type of the secret

idanyrequired

The ID of the secret

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://api.bytenite.com/v1/auth/secrets/{secretType}/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

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

A successful response.

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://api.bytenite.com/v1/auth/secrets' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

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

A successful response.

List available secrets

Remove a secret

Create or update a secret

Show child attributes