Viewport daemon, relay, and hosted runtime are available in alpha. Surfaces may change.
VIEWPORT
ReferenceAPI reference

Plans

11 operations in the Plans group.

11 of 11 operations on this page are generated contract stubs: the routes are real, the schemas are placeholders pending the owning subsystem's contract pass.

GET /api/plans

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiPlans

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/plans

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiPlans

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/plans/{plan}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiPlansPlan

Parameters

NameInRequiredTypeDescription
planpathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/plans/{plan}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: patchApiPlansPlan

Parameters

NameInRequiredTypeDescription
planpathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/plans/{plan}/encryption-recipients

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiPlansPlanEncryptionRecipients

Parameters

NameInRequiredTypeDescription
planpathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/plans/{plan}/feedback/{feedbackItem}/apply-suggestion

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiPlansPlanFeedbackFeedbackItemApplySuggestion

Parameters

NameInRequiredTypeDescription
planpathyesstring
feedbackItempathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/plans/{plan}/feedback/{feedbackItem}/reopen

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiPlansPlanFeedbackFeedbackItemReopen

Parameters

NameInRequiredTypeDescription
planpathyesstring
feedbackItempathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/plans/{plan}/feedback/{feedbackItem}/resolve

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiPlansPlanFeedbackFeedbackItemResolve

Parameters

NameInRequiredTypeDescription
planpathyesstring
feedbackItempathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/plans/{plan}/review

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiPlansPlanReview

Parameters

NameInRequiredTypeDescription
planpathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/plans/{plan}/shares

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiPlansPlanShares

Parameters

NameInRequiredTypeDescription
planpathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/plans/{plan}/shares/{share}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiPlansPlanSharesShare

Parameters

NameInRequiredTypeDescription
planpathyesstring
sharepathyesstring

Request body — application/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content—
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

Pairing Codes

5 operations in the Pairing Codes group.

Policy

2 operations in the Policy group.

On this page

GET /api/plansPOST /api/plansGET /api/plans/{plan}PATCH /api/plans/{plan}GET /api/plans/{plan}/encryption-recipientsPOST /api/plans/{plan}/feedback/{feedbackItem}/apply-suggestionPOST /api/plans/{plan}/feedback/{feedbackItem}/reopenPOST /api/plans/{plan}/feedback/{feedbackItem}/resolvePOST /api/plans/{plan}/reviewPOST /api/plans/{plan}/sharesDELETE /api/plans/{plan}/shares/{share}