Expand description
Models for interacting with the Defined Networking API.
Structs§
- APIError
APIErrorrepresents a single error returned in an API error response.- Check
ForUpdate Response CheckForUpdateResponseis the response generated for aCheckForUpdaterequest.- Check
ForUpdate Response Wrapper CheckForUpdateResponseWrappercontains a response toCheckForUpdateinside “data.”- DoUpdate
Request DoUpdateRequestis the request sent for aDoUpdaterequest.- DoUpdate
Response - A server response to a
DoUpdateRequest, with the updated config and key information - Enroll
Request EnrollRequestis issued to theENROLL_ENDPOINTto enroll thisdnclientwith a dnapi organization- Enroll
Response Data - The data included in an successful enrollment.
- Enroll
Response Data Org - The organization data that this node is now a part of
- Request
V1 RequestV1is the version 1DNClientrequest message.- Request
Wrapper RequestWrapperwraps aDNClientrequest message. It consists of a type and value, with the type string indicating how to interpret the value blob.- Signed
Response SignedResponsecontains a response message and a signature to validate.- Signed
Response Wrapper SignedResponseWrappercontains a response message and a signature to validate insidedata.
Enums§
- Enroll
Response - The response to an
EnrollRequest
Constants§
- CHECK_
FOR_ UPDATE - The
CheckForUpdatemessage type - DO_
UPDATE - The
DoUpdatemessage type - ENDPOINT_
V1 - The version 1
DNClientAPI endpoint - ENROLL_
ENDPOINT - The REST enrollment endpoint
Type Aliases§
- APIErrors
- A type alias to a array of
APIErrors. Just for parity with dnapi.