manage rotation scripts
Download Specoauth
Required Scopes:
admin
hostsView
service
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
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"
}
]
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
array[object]
object
script code to run in target
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
name
string
script
string
oauth
Required Scopes:
admin
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
inserted
{
"id": "5bf77342-221c-11ee-be56-0242ac120002"
}
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
id
string
uuid
Id of the created resource
id
string
required
oauth
Required Scopes:
admin
hostsView
service
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
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"
}
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
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
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
id
string
required
oauth
Required Scopes:
admin
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
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"
}
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
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
id
string
required
oauth
Required Scopes:
admin
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
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
operating_system
string
- Enum
-
- LINUX
- WINDOWS
script
string
oauth
Required Scopes:
admin
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
example script
{
"script": "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
script
string
script compiled with test data
Was this page helpful?