v2-metadata
Download SpecThis endpoint retrieves the metadata and versions for the secret at the specified path. Metadata is version-agnostic.
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
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
Response
return metdata + vsn metadatas
{
"metadata": {
"created": "string",
"created_by": "string",
"updated": "string",
"updated_by": "string",
"current_version": 123,
"max_versions": 123,
"delete_version_after": "string",
"oldest_version": 123
},
"versions": [
{
"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
metadata
object (metadata)
created
string
creation time
created_by
string
creator
updated
string
updation time
updated_by
string
updater
current_version
int
latest usable version
max_versions
int
length of password history
delete_version_after
string
remove deleted versions after the duration
oldest_version
int
oldest version
versions
array[object]
object
version
int
version number
created
string
creation time
deletion_time
string
deletion time
destroyed
boolean
version marked for removal
This endpoint creates or updates the metadata of a secret at the specified location. It does not create a new version.
created
string
creation time
created_by
string
creator
updated
string
updation time
updated_by
string
updater
current_version
int
latest usable version
max_versions
int
length of password history
delete_version_after
string
remove deleted versions after the duration
oldest_version
int
oldest version
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
Host secret deleted
{
"created": "string",
"created_by": "string",
"updated": "string",
"updated_by": "string",
"current_version": 123,
"max_versions": 123,
"delete_version_after": "string",
"oldest_version": 123
}
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
created
string
creation time
created_by
string
creator
updated
string
updation time
updated_by
string
updater
current_version
int
latest usable version
max_versions
int
length of password history
delete_version_after
string
remove deleted versions after the duration
oldest_version
int
oldest version
This endpoint permanently deletes the key metadata and all version data for the specified key. All version history will be removed.
path
string
required
Secret name
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
Response
secret and versions 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
This endpoint returns a list of metadata and version key names at the specified location. Metadata are suffixed with /.
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
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
Response
List of keys
{
"keys": [
"string"
]
}
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
keys
array[string]
string
Was this page helpful?