logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

E-mail: admin@finmars.com License: BSD License Terms of Service

Finmars Documentation

Vault Engine

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create engine

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
engine_name
required
string (Engine name) [ 1 .. 255 ] characters

Responses

Request samples

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

Delete engine

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
engine_name
required
string (Engine name) [ 1 .. 255 ] characters

Responses

Request samples

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

Response samples

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

Vault Record

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) non-empty
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Bulk delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) non-empty
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Bulk restore

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) non-empty
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

List ev group

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) non-empty
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

List ev item

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) non-empty
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this vault record.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this vault record.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) non-empty
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Partial update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this vault record.

Request Body schema: application/json
required
user_code
string or null (User code) <= 255 characters
name
required
string (Name) non-empty
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "name": "string",
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this vault record.

Responses

Delete preview

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this vault record.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "deleted_user_code": "string"
}

Vault Secret

List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create secret

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
engine_name
required
string (Engine name) non-empty
path
required
string (Path) non-empty
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "engine_name": "string",
  • "path": "string",
  • "data": { }
}

Delete secret

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
engine_name
required
string (Engine name) non-empty
path
required
string (Path) non-empty

Responses

Request samples

Content type
application/json
{
  • "engine_name": "string",
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "engine_name": "string",
  • "path": "string"
}

Get metadata

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get secret

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
{
  • "engine_name": "string",
  • "path": "string",
  • "data": { }
}

Update secret

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
engine_name
required
string (Engine name) non-empty
path
required
string (Path) non-empty
version
required
integer (Version)
data
required
object (Data)

Responses

Request samples

Content type
application/json
{
  • "engine_name": "string",
  • "path": "string",
  • "version": 0,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "engine_name": "string",
  • "path": "string",
  • "version": 0,
  • "data": { }
}

Vault

Health

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Init

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
action
string (Action) [ 1 .. 255 ] characters
Default: "seal"

Responses

Request samples

Content type
application/json
{
  • "action": "seal"
}

Seal

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
action
string (Action) [ 1 .. 255 ] characters
Default: "seal"

Responses

Request samples

Content type
application/json
{
  • "action": "seal"
}

Get status

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Unseal

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
action
string (Action) [ 1 .. 255 ] characters
Default: "unseal"
key
required
string (Key) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "action": "unseal",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "action": "unseal",
  • "key": "string"
}