Skip to main content
PATCH
/
api
/
v1
/
byok
/
providers
/
{provider}
Create or update a BYOK provider key
curl --request PATCH \
  --url https://neo.api.projectdiscovery.io/api/v1/byok/providers/{provider} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "<string>",
  "display_name": "<string>",
  "location": "<string>"
}
'
{
  "provider_key": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_validated": true,
    "updated_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "location": "<string>"
  },
  "validation": {
    "valid": true,
    "details": "<string>",
    "error": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

JWT authentication token

Path Parameters

​
provider
enum<string>
required

Provider identifier

Available options:
openrouter,
anthropic,
openai,
google,
xai,
vercel-gateway,
google-vertex,
amazon-bedrock

Body

application/json
​
api_key
string
required

The provider API key (will be encrypted at rest). For google-vertex: must be the full GCP service account JSON string (containing type, client_email, private_key, project_id).

​
display_name
string | null

Optional display name for this key

​
location
string | null

Cloud region for region-aware providers:

  • google-vertex: GCP region for Vertex AI (e.g. "us-central1", "us-east5"). Defaults to "us-central1".
  • amazon-bedrock: AWS region (e.g. "us-east-1"). Defaults to "us-east-1".

Response

Provider key created or updated

​
provider_key
object
required

A configured BYOK provider API key

​
validation
object
required