Skip to main content

Download OpenAPI specification:Download

Data Protection

List all templates

Get a list of all templates

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new template

Add a new template with the specified details

path Parameters
templatename
required
string

Template Name

header Parameters
x-api-key
required
string

Javelin API Key

Request Body schema: application/json
required

Template details

config
object

Template specific configuration

created_at
string
created_by
string
description
string

Description for the Template

enabled
boolean

Whether the Template is enabled or not

Array of objects (model.ModelConfig)

Models from spaCy, Cloud DLP etc.

modified_at
string
modified_by
string
name
string

Short Name for the Template like "inspect", "deidentify", "reidentify" etc.

type
string

Type of the Template, e.g. spaCy, Cloud DLP etc.

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "enabled": true,
  • "models": [
    ],
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Delete a template

Remove a template by name

path Parameters
templatename
required
string

Template Name

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get a specific template

Retrieve details of a specific template by name

path Parameters
templatename
required
string

Template Name

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "enabled": true,
  • "models": [
    ],
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Update a template

Update details of an existing template

path Parameters
templatename
required
string

Template Name

header Parameters
x-api-key
required
string

Javelin API Key

Request Body schema: application/json
required

Template details

config
object

Template specific configuration

created_at
string
created_by
string
description
string

Description for the Template

enabled
boolean

Whether the Template is enabled or not

Array of objects (model.ModelConfig)

Models from spaCy, Cloud DLP etc.

modified_at
string
modified_by
string
name
string

Short Name for the Template like "inspect", "deidentify", "reidentify" etc.

type
string

Type of the Template, e.g. spaCy, Cloud DLP etc.

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "enabled": true,
  • "models": [
    ],
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Gateways

List all gateways

List all gateways

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "gateway_id": "string",
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Create a new gateway

Create a new gateway

header Parameters
x-api-key
required
string

Javelin API Key

Request Body schema: application/json
required

Gateway

config
object

Configuration of the gateway

created_at
string

Creation timestamp

created_by
string

Creator of the gateway

enabled
boolean

Whether the gateway is enabled

gateway_id
string

Unique identifier for the gateway

modified_at
string

Modification timestamp

modified_by
string

Last modifier of the gateway

name
string

Name of the gateway

type
string

Type of the gateway

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "gateway_id": "string",
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Response samples

Content type
application/json
"string"

Delete a gateway by name

Delete a gateway by name

path Parameters
gatewayname
required
string

Gateway Name

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
"string"

Get a gateway by name

Get a gateway by name

path Parameters
gatewayname
required
string

Gateway Name

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "gateway_id": "string",
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Update an existing gateway

Update an existing gateway

path Parameters
gatewayname
required
string

Gateway Name

header Parameters
x-api-key
required
string

Javelin API Key

Request Body schema: application/json
required

Gateway

config
object

Configuration of the gateway

created_at
string

Creation timestamp

created_by
string

Creator of the gateway

enabled
boolean

Whether the gateway is enabled

gateway_id
string

Unique identifier for the gateway

modified_at
string

Modification timestamp

modified_by
string

Last modifier of the gateway

name
string

Name of the gateway

type
string

Type of the gateway

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "gateway_id": "string",
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Response samples

Content type
application/json
"string"

Providers

List all providers

Get a list of all providers

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new provider

Add a new provider with the specified details

header Parameters
x-api-key
required
string

Javelin API Key

Request Body schema: application/json
required

Provider details

api_keys
Array of objects

API keys associated with the provider

config
object

Configuration of the provider

created_at
string

Creation timestamp

created_by
string

Creator of the provider

enabled
boolean

Whether the provider is enabled

modified_at
string

Modification timestamp

modified_by
string

Last modifier of the provider

name
string

Name of the provider

type
string

Type of the provider

vault_enabled
boolean

Whether the provider's vault is enabled

Responses

Request samples

Content type
application/json
{
  • "api_keys": [
    ],
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string",
  • "vault_enabled": true
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Delete a provider

Remove a provider by name

path Parameters
providername
required
string

Provider Name

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get a specific provider

Retrieve a specific provider by name

path Parameters
providername
required
string

Provider Name

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
{
  • "api_keys": [
    ],
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string",
  • "vault_enabled": true
}

Update a provider

Update an existing provider

path Parameters
providername
required
string

Provider Name

header Parameters
x-api-key
required
string

Javelin API Key

Request Body schema: application/json
required

Provider details

api_keys
Array of objects

API keys associated with the provider

config
object

Configuration of the provider

created_at
string

Creation timestamp

created_by
string

Creator of the provider

enabled
boolean

Whether the provider is enabled

modified_at
string

Modification timestamp

modified_by
string

Last modifier of the provider

name
string

Name of the provider

type
string

Type of the provider

vault_enabled
boolean

Whether the provider's vault is enabled

Responses

Request samples

Content type
application/json
{
  • "api_keys": [
    ],
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string",
  • "vault_enabled": true
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Secrets

Delete an API key

Delete an API key by name

path Parameters
providername
required
string

Provider Name

keyname
required
string

Key Name

header Parameters
x-api-key
required
string

Javelin API Key

x-javelin-namespace
required
string

Namespace

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get a specific API key

Retrieve a specific API key by name

path Parameters
providername
required
string

Provider Name

keyname
required
string

Key Name

header Parameters
x-api-key
required
string

Javelin API Key

x-javelin-namespace
required
string

Namespace

Responses

Response samples

Content type
application/json
{
  • "api_key": "string",
  • "api_key_secret_key": "string",
  • "api_key_secret_key_javelin": "string",
  • "api_key_secret_name": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "group": "string",
  • "header_key": "string",
  • "modified_at": "string",
  • "modified_by": "string",
  • "organization": "string",
  • "provider_name": "string",
  • "query_param_key": "string"
}

Create a new API key

Create a new API key with the specified details

path Parameters
providername
required
string

Provider Name

keyname
required
string

Key Name

header Parameters
x-api-key
required
string

Javelin API Key

x-javelin-namespace
required
string

Namespace

Request Body schema: application/json
required

API Key details

api_key
string
api_key_secret_key
string
api_key_secret_key_javelin
string
api_key_secret_name
string
created_at
string
created_by
string
enabled
boolean
group
string
header_key
string
modified_at
string
modified_by
string
organization
string
provider_name
string
query_param_key
string

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "api_key_secret_key": "string",
  • "api_key_secret_key_javelin": "string",
  • "api_key_secret_name": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "group": "string",
  • "header_key": "string",
  • "modified_at": "string",
  • "modified_by": "string",
  • "organization": "string",
  • "provider_name": "string",
  • "query_param_key": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Update an API key

Update an existing API key

path Parameters
providername
required
string

Provider Name

keyname
required
string

Key Name

header Parameters
x-api-key
required
string

Javelin API Key

x-javelin-namespace
required
string

Namespace

Request Body schema: application/json
required

API Key details

api_key
string
api_key_secret_key
string
api_key_secret_key_javelin
string
api_key_secret_name
string
created_at
string
created_by
string
enabled
boolean
group
string
header_key
string
modified_at
string
modified_by
string
organization
string
provider_name
string
query_param_key
string

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "api_key_secret_key": "string",
  • "api_key_secret_key_javelin": "string",
  • "api_key_secret_name": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "group": "string",
  • "header_key": "string",
  • "modified_at": "string",
  • "modified_by": "string",
  • "organization": "string",
  • "provider_name": "string",
  • "query_param_key": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

List API keys

List all API keys

path Parameters
providername
required
string

Provider Name

header Parameters
x-api-key
required
string

Javelin API Key

x-javelin-namespace
required
string

Namespace

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Routes

List all routes by filter

Get a list of all routes by filter

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new route

Add a new route with the specified details

header Parameters
x-api-key
required
string

Javelin API Key

Request Body schema: application/json
required

Route details

config
object

Configuration of the route

created_at
string

Creation timestamp

created_by
string

Creator of the route

enabled
boolean

Whether the route is enabled

Array of objects (model.ModelConfig)

Models associated with the route

modified_at
string

Modification timestamp

modified_by
string

Last modifier of the route

name
string

Name of the route

type
string

Type of the route

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "models": [
    ],
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Delete a route

Remove a route by name

path Parameters
routename
required
string

Route Name

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get a specific route

Retrieve a specific route by name

path Parameters
routename
required
string

Route Name

header Parameters
x-api-key
required
string

Javelin API Key

Responses

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "models": [
    ],
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Update a route

Update an existing route

path Parameters
routename
required
string

Route Name

header Parameters
x-api-key
required
string

Javelin API Key

Request Body schema: application/json
required

Route details

config
object

Configuration of the route

created_at
string

Creation timestamp

created_by
string

Creator of the route

enabled
boolean

Whether the route is enabled

Array of objects (model.ModelConfig)

Models associated with the route

modified_at
string

Modification timestamp

modified_by
string

Last modifier of the route

name
string

Name of the route

type
string

Type of the route

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "created_at": "string",
  • "created_by": "string",
  • "enabled": true,
  • "models": [
    ],
  • "modified_at": "string",
  • "modified_by": "string",
  • "name": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Query Routes

Query a Route

Query data for a specific route

path Parameters
routename
required
string

Route name

Responses

Response samples

Content type
application/json
{ }