Open in Claude Open in ChatGPT

Vault

A Data Store

Table of Contents

A vault is a data store where you store backups, replications and exports of your data. A vault contains archives which are packages of your data.

Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Vault is contained within a Platform.

Objects

This Vault contains the following objects:

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
binaryStorageProviderType string No The type identifier for the binary storage provider that backs this data store
datastoreId string Yes The ID of the data store
datastoreTypeId string Yes The data store type identifier
description string No A description of the data store
enableAuthorities boolean true No Whether to check access control rights for principals against this data store
locked boolean Yes Whether the data store is presently locked. If the data store is locked, then write operations against it will block.
lockedBy string No The principal that holds the lock (if the data store is locked)
maxsize number No The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit.
objectcount number No The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read.
size number Yes The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read.
statisticsDate object No Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations.
statisticsDirty boolean Yes Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity.
title string No The title of the data store

Methods

The following methods are available:

Add Team Member

Adds a principal as a member of a Team against the given vault
POST /vaults/{vaultId}/teams/{teamKey}/members/add

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team
id true string

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Check Membership

Checks whether a principal belongs to a Team for the given vault
POST /vaults/{vaultId}/teams/{teamKey}/members/check

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team
id true string

Response

{
  "type": "object",
  "description": "Belongs",
  "extends": "status",
  "properties": {
    "belongs": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check Permission

Checks whether one or more authorities against the specified vault are granted for a given set of users
POST /vaults/{vaultId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
vaultId true string The ID of the vault
permissionId true string The ID of the permission
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified vault for the given user
POST /vaults/{vaultId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
vaultId true string The ID of the vault
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified vault are granted for a given set of users
POST /vaults/authorities/check

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified vault are granted for a given set of users
POST /vaults/permissions/check

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Create Role

Creates a role for a webhost
POST /webhosts/{webhostId}/roles

Parameters

Name Required Type Description
webhostId true string The ID of the web host
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Create Role

Creates a role for a vault
POST /vaults/{vaultId}/roles

Parameters

Name Required Type Description
vaultId true string The ID of the vault
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Create Stat

POST /vaults/{vaultId}/stats

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Create Vault

Creates a new Vault
POST /vaults

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Create a Team

Creates a Team against the given vault
POST /vaults/{vaultId}/teams

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Delete File

Deletes a binary file from the vault
DELETE /vaults/{vaultId}/files/{filename}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
filename true string The filename that identifies the binary file

Delete Role

Deletes a role for a vault
POST /vaults/{vaultId}/roles/{roleKeyOrId}/delete

Parameters

Name Required Type Description
vaultId true string The ID of the vault
roleKeyOrId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Role

Deletes a role for a vault
DELETE /vaults/{vaultId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
roleKeyOrId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Role

Deletes a role for a webhost
DELETE /webhosts/{webhostId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
webhostId true string The ID of the web host
roleKeyOrId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Role

Deletes a role for a webhost
POST /webhosts/{webhostId}/roles/{roleKeyOrId}/delete

Parameters

Name Required Type Description
webhostId true string The ID of the web host
roleKeyOrId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Vault

Deletes an existing Vault
DELETE /vaults/{vaultId}

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Vault

Deletes an existing Vault
POST /vaults/{vaultId}/delete

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Deletes a Team

Deletes a Team against the given vault
DELETE /vaults/{vaultId}/teams/{teamKey}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Download File

Downloads a binary file from the vault
GET /vaults/{vaultId}/files/{filename}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
filename true string The filename that identifies the binary file

Export Vault

Starts an export job for this resource
POST /vaults/{vaultId}/export

Parameters

Name Required Type Description
vaultId true string The ID of the vault
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object",
      "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports."
    },
    "endDate": {
      "type": "object",
      "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports."
    },
    "startChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or beyond the specified changeset."
    },
    "endChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or before the specified changeset."
    },
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during export."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during export."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during export."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during export."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during export."
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Get Team

Retrieves a Team against the given vault
GET /vaults/{vaultId}/teams/{teamKey}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Grant Authority

Grants an authority against the specified vault to a given user
POST /vaults/{vaultId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
vaultId true string The ID of the vault
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Grant Authority to Team

Assigns an Authority to a Team for the given vault
POST /vaults/{vaultId}/teams/{teamKey}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team
authorityId true string The ID or authority key for the authority

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Import Vault

Starts an import job for this resource
POST /vaults/{vaultId}/import

Parameters

Name Required Type Description
vaultId true string The ID of the vault
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during import."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during import."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during import."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during import."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during import."
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": "CLONE",
      "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import."
    },
    "substitutions": {
      "type": "string"
    }
  }
}

List Roles

Lists the roles for a webhost
GET /webhosts/{webhostId}/roles

Parameters

Name Required Type Description
webhostId true string The ID of the web host
inherited false string

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

List Roles

Lists the roles for a vault
GET /vaults/{vaultId}/roles

Parameters

Name Required Type Description
vaultId true string The ID of the vault
inherited false string

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

List Team Authorities

Retrieves a list of the authorities defined to be granted by a Team
GET /vaults/{vaultId}/teams/{teamKey}/authorities

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "description": "List of Authorities",
  "properties": {
    "authorities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

List Teams

Lists the Teams against the given vault
GET /vaults/{vaultId}/teams

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Lists Team Members

Lists the members of a Team against the given vault
GET /vaults/{vaultId}/teams/{teamKey}/members

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Lists Vault

Retrieves a list of Vault instances
GET /vaults

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_vault"
      }
    }
  }
}

Lock Vault

POST /vaults/{vaultId}/lock

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Queries for Vault

Queries for instances of type Vault
POST /vaults/query

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_vault"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified vault
GET /vaults/{vaultId}/acl/list

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a vault and specific actor
GET /vaults/{vaultId}/acl

Parameters

Name Required Type Description
vaultId true string The ID of the vault
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified vault
POST /vaults/{vaultId}/authorities

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Role

Reads a role for a vault
GET /vaults/{vaultId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
roleKeyOrId true string
inherited false string

Response

{
  "$ref": "#/components/schemas/"
}

Read Role

Reads a role for a webhost
GET /webhosts/{webhostId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
webhostId true string The ID of the web host
roleKeyOrId true string
inherited false string

Response

{
  "$ref": "#/components/schemas/"
}

Read Vault

Reads an instance of a Vault
GET /vaults/{vaultId}

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "extends": "datastore",
  "description": "Vault",
  "container": "platform",
  "properties": {
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  }
}

Remove Team Member

Remove a principal from a team's membership list
POST /vaults/{vaultId}/teams/{teamKey}/members/remove

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Revoke Authority

Revokes an authority against the specified vault from a given user
POST /vaults/{vaultId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
vaultId true string The ID of the vault
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Revoke Authority from Team

Revokes an Authority from a Team for the given vault
POST /vaults/{vaultId}/teams/{teamKey}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team
authorityId true string The ID or authority key for the authority

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Unlock Vault

POST /vaults/{vaultId}/unlock

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Update Role

Updates a role for a vault
PUT /vaults/{vaultId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
roleKeyOrId true string
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Role

Updates a role for a webhost
PUT /webhosts/{webhostId}/roles/{roleKeyOrId}

Parameters

Name Required Type Description
webhostId true string The ID of the web host
roleKeyOrId true string
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Role

Updates a role for a webhost
POST /webhosts/{webhostId}/roles/{roleKeyOrId}/update

Parameters

Name Required Type Description
webhostId true string The ID of the web host
roleKeyOrId true string
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Role

Updates a role for a vault
POST /vaults/{vaultId}/roles/{roleKeyOrId}/update

Parameters

Name Required Type Description
vaultId true string The ID of the vault
roleKeyOrId true string
HTTP Payload true string HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Team

POST /vaults/{vaultId}/teams/{teamKey}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
teamKey true string The key identifier for the team

Update Vault

Updates an existing Vault
PUT /vaults/{vaultId}

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Vault

Updates an existing Vault
POST /vaults/{vaultId}/update

Parameters

Name Required Type Description
vaultId true string The ID of the vault

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Upload File

Uploads a binary file to the vault. The request's content type header and stream are written into the binary identified by the filename.
POST /vaults/{vaultId}/files/{filename}

Parameters

Name Required Type Description
vaultId true string The ID of the vault
filename true string The filename that identifies the binary file

Schema


{
  "type": "object",
  "extends": "datastore",
  "description": "Vault",
  "container": "platform",
  "properties": {
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  },
  "id": "vault"
}