Create release request

post

https://example.com/beyondtrust/api/public/v3/requests

Creates a new release request.

Required Permission(s)

Any of the following:

Requestor role to managed account referenced by ID
Requestor/Approver role to managed account referenced by ID

Notes

In reference to RotateOnCheckin, If the Managed Account given in AccountID does not rotate the credentials after check-in/expiry, this setting is ignored.
For more information, see the Allow API Rotation Override access policy setting under View access.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Details for release request to be added

DurationMinutes

int32

(minutes: 1-525600) The request duration

AccessPolicyScheduleID

int32 | null

ID of the Access policy schedule. Auto-selects best schedule if omitted

ConflictOption

string | null

Conflict handling when an active request already exists for the same user, system, and account. Use 'reuse' to return the existing request; use 'renew' to create a new request

TicketSystemID

int32 | null

ID of the ticket system. Uses default if omitted

TicketNumber

string | null

Associated ticket number. Can be required if ticket system is marked as required in the access policy used

RotateOnCheckin

boolean

Defaults to true

Rotate credentials on check-in/expiry if supported by policy

AccessType

string | null

Type of access requested(View | RDP | SSH | App)

SystemID

int32

ID of the managed system to request

AccountID

int32

ID of the managed account to request

ApplicationID

int32 | null

ID of the application for application-based requests

Reason

string | null

Reason for the request

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Existing request is being reused. Existing request ID in the response body.

201Request successful. Request ID in the response body.

400Bad Request

403User does not have permissions to request the indicated account or the account does not have API access enabled. Response body contains a status code: 4031 - User does not have permission to request the account. 4033 - Approver Only API or account. 4035 - Not enough Approvers configured.

409Conflicting request exists. This user or another user has already requested a password for the specified account within the next durationMinutes window.