Skip to main content
PUT
Update external grader

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Path Parameters

graderId
string<uuid>
required

External grader identifier (UUID)

Body

application/json

Body for replacing an external grader's mutable fields. Full-replace semantics — every field is required, including authenticationCredential (must be re-supplied even when unchanged so the platform can re-probe with plaintext).

url
string<uri>
required

HTTPS URL of the grading endpoint. Must resolve to a public host.

Maximum string length: 2048
status
enum<string>
required

Lifecycle state of an external grader

Available options:
active,
revoked
authenticationType
enum<string>
required

How the platform authenticates outbound calls to the grader.

Available options:
none,
api_key
authenticationCredential
string | null
required
write-only

Credential material sent on every outbound call to the grader. Must be null when authenticationType is none; required (non-empty string) when authenticationType is api_key. Encrypted at rest via KMS; never returned in any response. Wire mapping: api_keyX-Api-Key: <credential>.

Required string length: 1 - 16384

Response

External grader updated

External grader as visible to the registering caller. authenticationCredential is deliberately absent — write-only material never leaves the platform.

id
string<uuid>
required

Stable identifier. Content items bind to graders by this id.

url
string<uri>
required

Grading endpoint URL.

authenticationType
enum<string>
required

How the platform authenticates outbound calls to the grader.

Available options:
none,
api_key
status
enum<string>
required

Lifecycle state of an external grader

Available options:
active,
revoked
dateCreated
string<date-time>
required

ISO 8601 timestamp of registration.

dateLastModified
string<date-time>
required

ISO 8601 timestamp of the last modification.