Authentication

To manage data in a vault, you need to create and authenticate a service account for the vault. See Create a Service Account for a tutorial. Once you’ve done that, you should have a Bearer Token for your service account. To authenticate your requests, simply include it as a header parameter as follows:

authorization : Bearer {BEARER_TOKEN}.

Bearer

Access token, prefixed by Bearer: Bearer <token>. Retrieved using Generate Tokens End-Point

Security Scheme Type API Key
Header parameter name: Authorization

OAuth2

Authentication using OAuth 2.0 with Grant Type as the authorization code.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://api.skyflow.com/oauth/authorize
Token URL: https://api.skyflow.com/oauth/token
Scopes:
  • admin -

    Grants read and write access to the administrative information.

  • developer -

    Grants developer access.

  • viewer -

    Grants read-only access.

List Inbound connection

List gateway inbound connection on given account

Authorizations:
query Parameters
offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve.

vaultID
string

vaultID for which connections defined. ID of the Workspace to search the Vault

fetchIDonly
boolean

Fetch connection IDs Only. Flag specifying if the returned values should only contain a connection IDs.

Responses

Request samples

curl -i -X GET \
  'https://manage.skyflowapis.com/v1/gateway/inboundRoutes?offset=0&limit=25&vaultID=string&fetchIDonly=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "ConnectionMappings": [
    ]
}

Create obutbound gateway Config

Creates a new outbound gateway configurations

Authorizations:
Request Body schema: application/json

connection Mappings with details

ID
string

Unique ID of the connection

name
string

name of of the connection

mode
string (v1RelayModes)
Default: "MODENONE"
Enum: "MODENONE" "INGRESS" "EGRESS"
baseURL
string

baseURL for the Endpoint we are hitting

vaultID
string

Backed VaultID

Array of objects (v1RelayRoute)

All the routes for this connection

authMode
string (v1RelayAuthMode)
Default: "NOAUTH"
Enum: "NOAUTH" "MTLS" "SHAREDKEY"
description
string

Description of the connections

Responses

Request samples

Content type
application/json
{
  • "ID": "string",
  • "name": "string",
  • "mode": "MODENONE",
  • "baseURL": "string",
  • "vaultID": "string",
  • "routes": [
    ],
  • "authMode": "NOAUTH",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "ID": "string",
  • "connectionURL": "string"
}

Get connections

Get an existing inbound gateway connection configurations

Authorizations:
path Parameters
ID
required
string

connection ID

Responses

Request samples

curl -i -X GET \
  https://manage.skyflowapis.com/v1/gateway/inboundRoutes/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "ID": "string",
  • "name": "string",
  • "mode": "MODENONE",
  • "baseURL": "string",
  • "vaultID": "string",
  • "routes": [
    ],
  • "authMode": "NOAUTH",
  • "description": "string"
}

Delete inbound connection

Deletes given gateway inbound connection

Authorizations:
path Parameters
ID
required
string

Deletes the connection config

Responses

Request samples

curl -i -X DELETE \
  https://manage.skyflowapis.com/v1/gateway/inboundRoutes/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{ }

Update connection

Updates given gateway inbound connection

Authorizations:
path Parameters
ID
required
string

c=Connection ID

Request Body schema: application/json

Connection mappings

ID
string

Unique ID of the connection

name
string

name of of the connection

mode
string (v1RelayModes)
Default: "MODENONE"
Enum: "MODENONE" "INGRESS" "EGRESS"
baseURL
string

baseURL for the Endpoint we are hitting

vaultID
string

Backed VaultID

Array of objects (v1RelayRoute)

All the routes for this connection

authMode
string (v1RelayAuthMode)
Default: "NOAUTH"
Enum: "NOAUTH" "MTLS" "SHAREDKEY"
description
string

Description of the connections

Responses

Request samples

Content type
application/json
{
  • "ID": "string",
  • "name": "string",
  • "mode": "MODENONE",
  • "baseURL": "string",
  • "vaultID": "string",
  • "routes": [
    ],
  • "authMode": "NOAUTH",
  • "description": "string"
}

Response samples

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

List outbound connection

List All connection in account

Authorizations:
query Parameters
offset
string <int64>
Default: "0"

Pagination Offset. - indicates the record number to start retrieving data.

limit
string <int64>
Default: "25"

Pagination Limit. - indicates the number of records to retrieve.

vaultID
string

vaultID for which connections defined. ID of the Workspace to search the Vault

fetchIDonly
boolean

Fetch connection IDs Only. Flag specifying if the returned values should only contain a connection IDs.

Responses

Request samples

curl -i -X GET \
  'https://manage.skyflowapis.com/v1/gateway/outboundRoutes?offset=0&limit=25&vaultID=string&fetchIDonly=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "ConnectionMappings": [
    ]
}

Create outbound gateway Config

Creates a new outbound gateway config.

Authorizations:
Request Body schema: application/json

connection Mappings with details

ID
string

Unique ID of the connection

name
string

name of of the connection

mode
string (v1RelayModes)
Default: "MODENONE"
Enum: "MODENONE" "INGRESS" "EGRESS"
baseURL
string

baseURL for the Endpoint we are hitting

vaultID
string

Backed VaultID

Array of objects (v1RelayRoute)

All the routes for this connection

authMode
string (v1RelayAuthMode)
Default: "NOAUTH"
Enum: "NOAUTH" "MTLS" "SHAREDKEY"
description
string

Description of the connections

Responses

Request samples

Content type
application/json
{
  • "ID": "string",
  • "name": "string",
  • "mode": "MODENONE",
  • "baseURL": "string",
  • "vaultID": "string",
  • "routes": [
    ],
  • "authMode": "NOAUTH",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "ID": "string",
  • "connectionURL": "string"
}

Get outbound connection

Get an existing outbound gateway connection configurations

Authorizations:
path Parameters
ID
required
string

connection ID

Responses

Request samples

curl -i -X GET \
  https://manage.skyflowapis.com/v1/gateway/outboundRoutes/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "ID": "string",
  • "name": "string",
  • "mode": "MODENONE",
  • "baseURL": "string",
  • "vaultID": "string",
  • "routes": [
    ],
  • "authMode": "NOAUTH",
  • "description": "string"
}

Delete connection

Deletes passed in outbound connection

Authorizations:
path Parameters
ID
required
string

Deletes the connection config

Responses

Request samples

curl -i -X DELETE \
  https://manage.skyflowapis.com/v1/gateway/outboundRoutes/:ID \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{ }

Update Outbound connection

Updates the Passed in outbound connection

Authorizations:
path Parameters
ID
required
string

c=Connection ID

Request Body schema: application/json

Connection mappings

ID
string

Unique ID of the connection

name
string

name of of the connection

mode
string (v1RelayModes)
Default: "MODENONE"
Enum: "MODENONE" "INGRESS" "EGRESS"
baseURL
string

baseURL for the Endpoint we are hitting

vaultID
string

Backed VaultID

Array of objects (v1RelayRoute)

All the routes for this connection

authMode
string (v1RelayAuthMode)
Default: "NOAUTH"
Enum: "NOAUTH" "MTLS" "SHAREDKEY"
description
string

Description of the connections

Responses

Request samples

Content type
application/json
{
  • "ID": "string",
  • "name": "string",
  • "mode": "MODENONE",
  • "baseURL": "string",
  • "vaultID": "string",
  • "routes": [
    ],
  • "authMode": "NOAUTH",
  • "description": "string"
}

Response samples

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

Uploads Auth

Uploads authentication information(certs/shared secret) for outbound gateway connections

Authorizations:
path Parameters
ID
required
string
Request Body schema: application/json
ID
string (connection ID)
object (v1RelayAuthSecret)
authMode
string (v1RelayAuthMode)
Default: "NOAUTH"
Enum: "NOAUTH" "MTLS" "SHAREDKEY"

Responses

Request samples

Content type
application/json
{
  • "ID": "string",
  • "routeSecret": {
    },
  • "authMode": "NOAUTH"
}

Response samples

Content type
application/json
{ }