manage rotation scripts

Download Spec

get /secrets-manager/api/v1/script-templates

get all script templates

OAuth2 oauth

Required Scopes:

adminhostsViewservice

get all script templates

All Scopes

  • admin · Admin scope - used for built-in PrivX admin account
  • hostsManage · Clients with hosts-manage scope
  • hostsProvisioning · Deploy script users
  • hostsView · Clients with hosts-view scope
  • service · Microservice scope - used for communication between PrivX microservices
  • user · Normal users
Flow Type:
authorization_code
Auth URL:
https://api.x.com/v1/auth/auth
Token URL:
https://api.x.com/v1/auth/auth

Response

ExamplesSchema

policies array

[
  {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string",
    "operating_system": "LINUX",
    "script": "string",
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  }
]

post /secrets-manager/api/v1/script-template

insert a new script template to db

name

string

script

string

Request

{
  "name": "string",
  "script": "string"
}

Response

ExamplesSchema

inserted

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}

get /secrets-manager/api/v1/script-template/{id}

get a script template

id

string

required

Response

ExamplesSchema

scripts array

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "operating_system": "LINUX",
  "script": "string",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "created_by": "string",
  "updated_by": "string"
}

put /secrets-manager/api/v1/script-template/{id}

update a script template

id

string

uuid

name

string

operating_system

string

powershell for windows and Unix Shell for Linux

Enum
  • LINUX
  • WINDOWS

script

string

script as string

created

string

date-time

When the object was created. Added by backend

Example
"2017-01-01T15:05:05Z"

updated

string

date-time

When the object was updated. Added by backend

Example
"2017-01-01T15:05:05Z"

created_by

string

added by backend

updated_by

string

added by backend

Request

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "operating_system": "LINUX",
  "script": "string",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "created_by": "string",
  "updated_by": "string"
}

Response

ExamplesSchema

inserted

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "operating_system": "LINUX",
  "script": "string",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "created_by": "string",
  "updated_by": "string"
}

delete /secrets-manager/api/v1/script-template/{id}

delete a script template

id

string

required

Response

ExamplesSchema

deleted

Empty response

post /secrets-manager/api/v1/script-template/compile

compile script with test data

operating_system

string

Enum
  • LINUX
  • WINDOWS

script

string

Request

{
  "operating_system": "LINUX",
  "script": "string"
}

Response

ExamplesSchema

example script

{
  "script": "string"
}

Was this page helpful?