v2-versions
Download SpecThis endpoint issues a soft delete of the specified versions of the secret. This marks the versions as deleted and will stop them from being returned from reads, but the underlying data will not be removed. A delete can be undone using the undelete path.
path
string
required
Secret name
oauth
Required Scopes:
admin
hostsManage
service
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
hostsManage
· Clients with hosts-manage scope -
owner
· User who owns the secrets -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users -
vaultAdd
· Client with vault-add scope -
vaultManage
· Client with vault-manage scope
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Versions marked soft deleted
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Undeletes the data for the provided versions and path. This restores the data, allowing it to be returned on get requests.
path
string
required
Secret name
oauth
Required Scopes:
admin
hostsManage
service
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
hostsManage
· Clients with hosts-manage scope -
owner
· User who owns the secrets -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users -
vaultAdd
· Client with vault-add scope -
vaultManage
· Client with vault-manage scope
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Versions made available again
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Permanently removes the specified version data for the provided key and version numbers from the vault.
path
string
required
Secret name
oauth
Required Scopes:
admin
service
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
hostsManage
· Clients with hosts-manage scope -
owner
· User who owns the secrets -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users -
vaultAdd
· Client with vault-add scope -
vaultManage
· Client with vault-manage scope
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Versions destroyed
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
version
int
Specifies the version to return. If not set the latest version is returned
oauth
Required Scopes:
service
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
hostsManage
· Clients with hosts-manage scope -
owner
· User who owns the secrets -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users -
vaultAdd
· Client with vault-add scope -
vaultManage
· Client with vault-manage scope
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
path
string
required
Secret name
Response
Version data
{
"data": {},
"metadata": {
"version": 123,
"created": "string",
"deletion_time": "string",
"destroyed": true
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
data
object (data)
the contents of the secret
metadata
object (metadata)
version
int
version number
created
string
creation time
deletion_time
string
deletion time
destroyed
boolean
version marked for removal
This endpoint creates a new version of a secret at the specified location
data
object (data)
oauth
Required Scopes:
service
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
hostsManage
· Clients with hosts-manage scope -
owner
· User who owns the secrets -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users -
vaultAdd
· Client with vault-add scope -
vaultManage
· Client with vault-manage scope
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
path
string
required
Secret name
Response
New version added
{
"version": 123,
"created": "string",
"deletion_time": "string",
"destroyed": true
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
version
int
version number
created
string
creation time
deletion_time
string
deletion time
destroyed
boolean
version marked for removal
This endpoint issues a soft delete of the secret's latest version at the specified location. This marks the version as deleted and will stop it from being returned from reads, but the underlying data will not be removed. A delete can be undone using the undelete path.
path
string
required
Secret name
oauth
Required Scopes:
admin
hostsManage
service
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
hostsManage
· Clients with hosts-manage scope -
owner
· User who owns the secrets -
service
· Microservice scope - used for communication between PrivX microservices -
user
· Normal users -
vaultAdd
· Client with vault-add scope -
vaultManage
· Client with vault-manage scope
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Latest version soft deleted
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Was this page helpful?