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

200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

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

200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

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

secretKeystringRequired

Your data source's secret key.

Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Responses

200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

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"
  }
}