Skip to content

GraphQL API⚓︎

Query⚓︎

Field Argument Type Description
getAccessPermissions [AccessPermission!]!
getAccessPermission AccessPermission!
id String!
getRoleAccessPermissions [AccessPermission!]!
role String!
getDeveloperAccessPermissions [AccessPermission!]!
developerId String!
getDataRedactions [DataRedaction!]!
getDataRedaction DataRedaction!
id String!
getRoleDataRedactions [DataRedaction!]!
role String!
getDeveloperDataRedactions [DataRedaction!]!
developerId String!
getRoles [DeveloperRole!]!
getRolePermissions [RolePermission!]!
role String!
getDeveloperRoles [DeveloperRole!]!
id String!
getDeveloperPermissions [RolePermission!]!
id String!
getDevelopers [Developer!]!
getLiveLogs [LiveLog!]!
getLiveBreakpoints [LiveBreakpoint!]!
getLiveInstruments [LiveInstrument!]!

Mutation⚓︎

Field Argument Type Description
addAccessPermission AccessPermission!
locationPatterns [String!]
type AccessType!
removeAccessPermission Boolean!
id String!
addRoleAccessPermission Boolean!
role String!
accessPermissionId String!
removeRoleAccessPermission Boolean!
role String!
accessPermissionId String!
addDataRedaction DataRedaction!
redactionPattern String!
removeDataRedaction Boolean!
id String!
addRoleDataRedaction Boolean!
role String!
dataRedactionId String!
removeRoleDataRedaction Boolean!
role String!
dataRedactionId String!
addRole Boolean!
role String!
removeRole Boolean!
role String!
addRolePermission Boolean!
role String!
permission String!
removeRolePermission Boolean!
role String!
permission String!
addDeveloperRole Boolean!
id String!
role String!
removeDeveloperRole Boolean!
id String!
role String!
addDeveloper Developer!
id String!
refreshAuthorizationCode Developer!
id String!
removeDeveloper Boolean!
id String!
removeLiveInstrument LiveInstrument
id String!
removeLiveInstruments [LiveInstrument!]!
source String!
line Int!
addLiveLog LiveLog!
input LiveLogInput!
addLiveBreakpoint LiveBreakpoint!
input LiveBreakpointInput!

Objects⚓︎

AccessPermission⚓︎

Field Argument Type Description
id String!
locationPatterns [String!]
type AccessType!

DataRedaction⚓︎

Field Argument Type Description
id String!
redactionPattern String!

Developer⚓︎

Field Argument Type Description
id String!
accessToken String

DeveloperRole⚓︎

Field Argument Type Description
roleName String!

LiveBreakpoint⚓︎

Field Argument Type Description
id String!
location LiveSourceLocation!
condition String
expiresAt Long
hitLimit Int
type LiveInstrumentType

LiveLog⚓︎

Field Argument Type Description
logFormat String!
logArguments [String!]!
id String!
location LiveSourceLocation!
condition String
expiresAt Long
hitLimit Int
type LiveInstrumentType

LiveSourceLocation⚓︎

Field Argument Type Description
source String!
line Int!

Inputs⚓︎

LiveBreakpointInput⚓︎

Field Type Description
location LiveSourceLocationInput!
condition String
expiresAt Long
hitLimit Int

LiveLogInput⚓︎

Field Type Description
logFormat String!
logArguments [String!]
location LiveSourceLocationInput!
condition String
expiresAt Long
hitLimit Int

LiveSourceLocationInput⚓︎

Field Type Description
source String!
line Int!

Enums⚓︎

AccessType⚓︎

Value Description
BLACK_LIST
WHITE_LIST

LiveInstrumentType⚓︎

Value Description
BREAKPOINT
LOG

RolePermission⚓︎

Value Description
ADD_DEVELOPER
REMOVE_DEVELOPER
GET_DEVELOPERS
REFRESH_DEVELOPER_TOKEN
ADD_ROLE
REMOVE_ROLE
GET_ROLES
GET_DEVELOPER_ROLES
ADD_DEVELOPER_ROLE
REMOVE_DEVELOPER_ROLE
GET_DEVELOPER_PERMISSIONS
GET_ROLE_PERMISSIONS
ADD_ROLE_PERMISSION
REMOVE_ROLE_PERMISSION
GET_ACCESS_PERMISSIONS
GET_DATA_REDACTIONS
UPDATE_DATA_REDACTION
ADD_ACCESS_PERMISSION
REMOVE_ACCESS_PERMISSION
ADD_LIVE_LOG
ADD_LIVE_BREAKPOINT
GET_LIVE_INSTRUMENTS
GET_LIVE_LOGS
GET_LIVE_BREAKPOINTS
REMOVE_LIVE_INSTRUMENT

Scalars⚓︎

Boolean⚓︎

Built-in Boolean

Int⚓︎

Built-in Int

Long⚓︎

Long type

String⚓︎

Built-in String

Interfaces⚓︎

LiveInstrument⚓︎

Field Argument Type Description
id String!
location LiveSourceLocation!
condition String
expiresAt Long
hitLimit Int
type LiveInstrumentType

Last update: March 27, 2023