DocumentationAPI ReferenceRelease Notes
API Reference

Update API registration

put
https://example.com/beyondtrust/api/public/v3/apiregistrations/

Updates an existing API registration.

Required Permission(s)

  • API Registration Management (Full control)

For Pathfinder Users Only

  • Usage of UserPasswordRequired and MultiFactorAuthenticationEnforced is blocked.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

ID of the API registration to update

Query Params
string
Defaults to 3.0

Request body version:

  • : Base properties
  • : Adds PersonalAccessTokenRequired
Body Params

Data model containing updated API registration configuration

int32
string | null
string | null
Defaults to apikeypolicy

Can be either "apikeypolicy" or "apiaccesspolicy"

boolean
Defaults to false

Indicates if the policy is active

boolean
Defaults to true
int32
Defaults to 60

Token duration in minutes. Only applicable when RegistrationType is "apiaccesspolicy"

boolean | null

Only applicable when RegistrationType is "apikeypolicy"

boolean
Defaults to false
boolean
Defaults to false

Only applicable when RegistrationType is "apikeypolicy"

boolean
Defaults to false

Only applicable when RegistrationType is "apikeypolicy"

IPAuthenticationRules
array of objects | null
IPAuthenticationRules
PSRUNRules
array of objects | null

Only applicable when RegistrationType is "apikeypolicy"

PSRUNRules
XForwardedForAuthenticationRules
array of objects | null
XForwardedForAuthenticationRules
boolean
Defaults to false

True if a Personal Access Token is required during API Authentication, otherwise false.

Applicable when BeyondTrust.PasswordSafe.API.Models.ApiRegistrationModel.RegistrationType is apikeypolicy

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 19 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.