openapi: 3.0.0 info: description: API for Synadia Control Plane / Synadia Cloud title: Synadia Control Plane / Synadia Cloud version: beta servers: - description: Path to Synadia Control Plane Server Api url: "{baseUrl}/api" variables: baseUrl: default: "" security: - bearerAuth: [] sessionAuth: [] tags: - description: App admin related functions name: Admin - description: Get resources related to the current user session name: Session - description: Manage NATS systems name: Systems - description: Manage teams name: Teams - description: Get Component Versions from Upstream name: Component Versions - description: Manage SCP Agent Access Tokens name: Agent Tokens - description: Manage NATS accounts name: Accounts - description: Manage NATS users name: NATS Users - description: Manage JetStream assets for an Account name: JetStream - description: Manage JetStream streams for an Account name: "JetStream: Streams" - description: Manage JetStream KV Buckets for an Account name: "JetStream: KV Buckets" - description: Manage JetStream Object Buckets for an Account name: "JetStream: Object Buckets" - description: Manage JetStream mirrors for an Account name: "JetStream: Mirrors" - description: Manage JetStream consumers for a Stream name: "JetStream: Consumers" - description: Share Streams and Services between Accounts name: Sharing - description: Manage alerts for NATS Systems and Accounts name: Alerts - description: Manage People with access to Control Plane name: App Users - description: Manage Authorization Policies for Control Plane users name: Authorization - description: Account Signing Key Groups name: Signing Key Groups - description: Manage user invitations name: Invitations - description: Manage NATS user issuances name: NATS User Issuances - description: Manage Team Service Accounts for accessing API name: Team Service Accounts - description: Manage App Service Accounts for accessing API name: App Service Accounts - description: NATS-based data pipelines name: NATS Connector Service - description: Manage Synadia Platform Components Configuration name: Platform Components - description: Manage Synadia Platform Workloads name: Workloads - description: Manage NATS Auth Callout Configuration name: Auth Callout - description: Manage Synadia Schema Registry name: Schema Registry - description: Manage OIDC authentication providers name: OIDC Providers - description: Manage Insights name: Insights - description: License status and entitlements name: License paths: /core/beta/account-sk-groups/{groupId}: delete: description: Deletes Account Signing Key Group operationId: deleteAccountSkGroup parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Account Signing Key Group tags: - sig-key-group x-doc-tags: - Signing Key Groups get: description: Get Account Signing Key Group operationId: getAccountSkGroup parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SigningKeyGroupViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Account Signing Key Group tags: - sig-key-group x-doc-tags: - Signing Key Groups patch: description: Update Account Signing Key Group operationId: updateAccountSkGroup parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SigningKeyGroupUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/SigningKeyGroupViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Account Signing Key Group tags: - sig-key-group x-doc-tags: - Signing Key Groups /core/beta/account-sk-groups/{groupId}/account-sks: get: description: List Account Signing Keys In Group operationId: listAccountSkGroupKeys parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SigningKeyListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Signing Keys tags: - sig-key-group x-doc-tags: - Signing Key Groups /core/beta/account-sk-groups/{groupId}/copy: post: description: "Copies Account SK Group. Copies all users from old SK group to\ \ the new SK group, generating new NKeys for copied users." operationId: copyAccountSkGroup parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SigningKeyGroupCopyRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/SigningKeyGroupViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Copy Account SK Group tags: - sig-key-group x-doc-tags: - Signing Key Groups /core/beta/account-sk-groups/{groupId}/nats-users: get: description: Returns a list of NATS users for the given signing key group operationId: listAccountSKGroupUsers parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List NATS Users tags: - sig-key-group x-doc-tags: - NATS Users /core/beta/account-sk-groups/{groupId}/rotate-sk: post: description: Rotates The Active Signing Key For Account Signing Key Group operationId: rotateAccountSk parameters: - explode: false in: path name: groupId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SigningKeyRotateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Roate Active Signing Key tags: - sig-key-group x-doc-tags: - Signing Key Groups /core/beta/account-sks/{keyId}: delete: description: Deletes Account Signing operationId: deleteAccountSk parameters: - explode: false in: path name: keyId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Account Signing tags: - sig-key x-doc-tags: - Signing Key Groups get: description: Get Account Signing operationId: getAccountSk parameters: - explode: false in: path name: keyId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SigningKeyViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Account Signing tags: - sig-key x-doc-tags: - Signing Key Groups patch: description: Update Account Signing operationId: updateAccountSk parameters: - explode: false in: path name: keyId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SigningKeyUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/SigningKeyViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Account Signing tags: - sig-key x-doc-tags: - Signing Key Groups /core/beta/accounts/{accountId}: delete: description: Deletes a Account in a system operationId: deleteAccount parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found "422": description: Unprocessable summary: Delete Account tags: - account x-doc-tags: - Accounts get: description: Returns a Account by ID operationId: getAccount parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Account tags: - account x-doc-tags: - Accounts patch: description: Updates a Account in a system operationId: updateAccount parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Account tags: - account x-doc-tags: - Accounts /core/beta/accounts/{accountId}/account-sk-groups: get: description: List Account Signing Key Groups operationId: listAccountSkGroup parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SigningKeyGroupListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Account Signing Key Groups tags: - account x-doc-tags: - Signing Key Groups post: description: Creates Account Signing Key Group operationId: createAccountSkGroup parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SigningKeyGroupCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/SigningKeyGroupCreateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Account Signing Key Group tags: - account x-doc-tags: - Signing Key Groups /core/beta/accounts/{accountId}/alert-rules: get: description: List Account Alert Rules operationId: listAlertRules parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertRuleListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Account Alert Rules tags: - account x-doc-tags: - Alerts post: description: Creates Account Alert Rule operationId: createAlertRule parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRuleAccountCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertRuleViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Account Alert Rule tags: - account x-doc-tags: - Alerts /core/beta/accounts/{accountId}/alert-rules/{alertRuleId}: delete: description: Deletes Account alert rule operationId: deleteAlertRule parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: alertRuleId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Account Alert Rule tags: - account x-doc-tags: - Alerts get: description: Get Account Alert Rule operationId: getAlertRule parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: alertRuleId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertRuleViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Account Alert Rule tags: - account x-doc-tags: - Alerts patch: description: Update Account Alert Rule operationId: updateAlertRule parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: alertRuleId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRuleUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertRuleViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Account Alert Rule tags: - account x-doc-tags: - Alerts /core/beta/accounts/{accountId}/alert-rules/{alertRuleId}/run: get: description: Run Account Alert Rule and return an alert object if the rule condition is met operationId: runAlertRule parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: alertRuleId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Run Account Alert Rule tags: - account x-doc-tags: - Alerts /core/beta/accounts/{accountId}/app-users: get: description: Returns a list of Team App Users associated with the Account operationId: listAccountTeamAppUsers parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Account Team App Users tags: - account x-doc-tags: - App Users /core/beta/accounts/{accountId}/app-users/{teamAppUserId}: delete: description: Unassign a Team App User from an Account operationId: unAssignAccountTeamAppUser parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: teamAppUserId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Unassign Team App User from Account tags: - account x-doc-tags: - App Users post: description: Assign a Team App User to an Account. This operation is idempotent; if an App User is already assigned to the Account the assignemnt will be updated with the new role operationId: assignAccountTeamAppUser parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: teamAppUserId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAssignRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Assign Team App User to Account tags: - account x-doc-tags: - App Users /core/beta/accounts/{accountId}/connections: get: description: List Account Connections operationId: listAccountConnections parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: true in: query name: sort required: false schema: type: string style: form - explode: true in: query name: cid required: false schema: type: string style: form - explode: true in: query name: state required: false schema: type: string style: form - explode: true in: query name: subject required: false schema: type: string style: form - explode: true in: query name: limit required: false schema: type: number style: form - explode: true in: query name: user required: false schema: type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AccountConnectionsListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Account Connections tags: - account x-doc-tags: - Accounts /core/beta/accounts/{accountId}/export: get: description: Export Account Seeds operationId: getAccountExport parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AccountExportResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Export Account Seeds tags: - account x-doc-tags: - Accounts /core/beta/accounts/{accountId}/info: get: description: Returns Account info operationId: getAccountInfo parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSAcctStats' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Account Info tags: - account x-doc-tags: - Accounts /core/beta/accounts/{accountId}/jetstream: get: description: List JetStream Assets operationId: listJetStreamAssets parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSStreamInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List JetStream Assets tags: - account x-doc-tags: - JetStream /core/beta/accounts/{accountId}/jetstream/kv-buckets: get: description: List KV buckets operationId: listKvBuckets parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSKVBucketListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List KV buckets tags: - account x-doc-tags: - "JetStream: KV Buckets" post: description: Creates KV Bucket operationId: createKvBucket parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSKVBucketConfig' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSKVBucketViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create KV Bucket tags: - account x-doc-tags: - "JetStream: KV Buckets" /core/beta/accounts/{accountId}/jetstream/mirrors: get: description: List Mirrors operationId: listMirrors parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSMirrorInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Mirrors tags: - account x-doc-tags: - "JetStream: Mirrors" post: description: Creates Mirror operationId: createMirror parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSMirrorConfigRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSMirrorInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Mirror tags: - account x-doc-tags: - "JetStream: Mirrors" /core/beta/accounts/{accountId}/jetstream/object-buckets: get: description: List Object buckets operationId: listObjectBuckets parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSObjectBucketListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Object buckets tags: - account x-doc-tags: - "JetStream: Object Buckets" post: description: Creates Object Bucket operationId: createObjectBucket parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSObjectBucketConfig' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSObjectBucketViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Object Bucket tags: - account x-doc-tags: - "JetStream: Object Buckets" /core/beta/accounts/{accountId}/jetstream/placement-options: get: description: Get available options for JetStream placement operationId: getJetStreamPlacementOptions parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSPlacementOptionsResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get JetStream Placement Options tags: - account x-doc-tags: - JetStream /core/beta/accounts/{accountId}/jetstream/streams: get: description: List Streams operationId: listStreams parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSStreamInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Streams tags: - account x-doc-tags: - "JetStream: Streams" post: description: Create Stream operationId: createStream parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSStreamConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSStreamInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Stream tags: - account x-doc-tags: - "JetStream: Streams" /core/beta/accounts/{accountId}/metrics: get: description: Returns Account metrics operationId: getAccountMetrics parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AccountMetrics' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Account Metrics tags: - account x-doc-tags: - Accounts /core/beta/accounts/{accountId}/nats-core/websocket/view: get: description: |- This endpoint enables connection to NATS over WebSocket using account credentials. It generates a user JWT from the account signing key and acts as a proxy to establish a connection with the first NATS server defined in a System. Options specified in the CONNECT request from client take priority, so the caller should avoid including authentication information in CONNECT to leverage automatic JWT injection. As a proxy, direct connection to NATS servers may be unavailable for the caller. Hence, it's advised to disregard all server update messages. In nats.ws, achieve this by setting 'ignoreClusterUpdates' to true. operationId: natsCoreWebsocketViewer parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: true in: query name: subject required: true schema: type: string style: form responses: "101": description: Switching Protocols "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Subscribe to a NATS Core subject over websockets tags: - account x-doc-tags: - Accounts /core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic}: delete: description: Deletes a Revocation for the given NATS User NKey operationId: deleteNatsUserRevocation parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: userNkeyPublic required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete a for a NATS User NKey tags: - account x-doc-tags: - Accounts get: description: Get Revocation for the given NATS User NKey operationId: getNatsUserRevocation parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: userNkeyPublic required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserRevocationViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Revocation for a NATS User NKey tags: - account x-doc-tags: - Accounts put: description: "Creates or Updates a Revocation for the given NATS User NKey.\ \ All users issued prior to 'before' will be revoked. If 'before' is set to\ \ 0, the current timestamp will be used." operationId: createOrUpdateNatsUserRevocation parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple - explode: false in: path name: userNkeyPublic required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/NatsUserRevocationRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserRevocationViewResponse' description: Success "201": content: application/json: schema: $ref: '#/components/schemas/NatsUserRevocationViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create or Update Revocation for a NATS User NKey tags: - account x-doc-tags: - Accounts /core/beta/accounts/{accountId}/nats-users: get: description: Returns a list of NATS users for the given account operationId: listUsers parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List NATS Users tags: - account x-doc-tags: - NATS Users post: description: Creates a NATS user for an account operationId: createUser parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/NatsUserCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/NatsUserViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create NATS User tags: - account x-doc-tags: - NATS Users /core/beta/accounts/{accountId}/stream-exports: get: description: List Stream Exports operationId: listStreamExports parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/StreamExportListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Stream Exports tags: - account x-doc-tags: - Sharing post: description: Creates Stream Export operationId: createStreamExport parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/StreamExportCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/StreamExportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Stream Export tags: - account x-doc-tags: - Sharing /core/beta/accounts/{accountId}/stream-imports: get: description: List Stream Imports operationId: listStreamImports parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/StreamImportListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Stream Imports tags: - account x-doc-tags: - Sharing post: description: Creates Stream Import operationId: createStreamImport parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/StreamImportCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/StreamImportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Stream Import tags: - account x-doc-tags: - Sharing /core/beta/accounts/{accountId}/stream-imports/shared: get: description: List stream exports shared with this account operationId: listStreamExportsShared parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/StreamExportSharedListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Shared Stream Exports tags: - account x-doc-tags: - Sharing /core/beta/accounts/{accountId}/subject-exports: get: description: List Subject Exports operationId: listSubjectExports parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SubjectExportListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Subject Exports tags: - account x-doc-tags: - Sharing post: description: Creates Subject Export operationId: createSubjectExport parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SubjectExportCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/SubjectExportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Subject Export tags: - account x-doc-tags: - Sharing /core/beta/accounts/{accountId}/subject-imports: get: description: List Subject Imports operationId: listSubjectImports parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SubjectImportListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Subject Imports tags: - account x-doc-tags: - Sharing post: description: Creates Subject Import operationId: createSubjectImport parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SubjectImportCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/SubjectImportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Subject Import tags: - account x-doc-tags: - Sharing /core/beta/accounts/{accountId}/subject-imports/shared: get: description: List subject exports shared with this account operationId: listSubjectExportsShared parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SubjectExportSharedListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Shared Subject Exports tags: - account x-doc-tags: - Sharing /core/beta/accounts/{accountId}/unmanage: delete: description: Unmanage a Account in a system operationId: unmanageAccount parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Unmanage Account tags: - account x-doc-tags: - Accounts /core/beta/admin/app-user: get: description: Check whether there is an App Admin user operationId: checkAppAdmin responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Check for Admin User tags: - admin x-doc-tags: - Admin post: description: "On clean installs, allows the programatic creation of the App\ \ Admin user" operationId: createAppAdmin requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminAppUserCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/AdminAppUserCreateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create an App Admin User tags: - admin x-doc-tags: - Admin /core/beta/agent-tokens/{tokenId}: delete: description: Delete an agent token operationId: deleteAgentToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Agent Token tags: - agent-token x-doc-tags: - Agent Tokens /core/beta/alerts: get: description: Returns a list of alerts operationId: listAlerts parameters: - explode: true in: query name: status required: false schema: type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Alerts tags: - session x-doc-tags: - Alerts /core/beta/alerts/{alertId}: get: description: Get Alert operationId: getAlert parameters: - explode: false in: path name: alertId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Alert tags: - alert x-doc-tags: - Alerts /core/beta/alerts/{alertId}/acknowledge: patch: description: Acknowledge Alert operationId: acknowledgeAlert parameters: - explode: false in: path name: alertId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Acknowledge Alert tags: - alert x-doc-tags: - Alerts /core/beta/app-users: get: description: List App Users operationId: listAppUsers responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List App Users tags: - session x-doc-tags: - App Users post: description: Create a User to invite to the Application operationId: createAppUser requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserCreateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create App User tags: - session x-doc-tags: - App Users /core/beta/app-users/{appUserId}: delete: description: Delete App User operationId: deleteAppUser parameters: - explode: false in: path name: appUserId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete App User tags: - app-user x-doc-tags: - App Users get: description: Get App User operationId: getAppUser parameters: - explode: false in: path name: appUserId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get App User tags: - app-user x-doc-tags: - App Users patch: description: Update App User operationId: updateAppUser parameters: - explode: false in: path name: appUserId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserUpdateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update App User tags: - app-user x-doc-tags: - App Users /core/beta/app-users/{appUserId}/roles: get: description: List an App User's Roles operationId: listAppUserRoles parameters: - explode: false in: path name: appUserId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Roles tags: - app-user x-doc-tags: - App Users /core/beta/app-users/{appUserId}/teams/{teamId}: post: description: Assign an App User to a Team. This operation is idempotent; if an App User is already assigned to a Team the assignment will be updated with the new role operationId: assignTeamAppUser parameters: - explode: false in: path name: appUserId required: true schema: type: string style: simple - explode: false in: path name: teamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAssignRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Assign App User to Team tags: - app-user x-doc-tags: - App Users /core/beta/auth-callout/{authCalloutId}: delete: description: Remove auth callout config and update the control account jwt operationId: deleteAuthCallout parameters: - explode: false in: path name: authCalloutId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Auth Callout Config tags: - auth-callout x-doc-tags: - Auth Callout get: description: Returns the Auth Callout Config operationId: getAuthCallout parameters: - explode: false in: path name: authCalloutId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuthCalloutViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Auth Callout Config tags: - auth-callout x-doc-tags: - Auth Callout /core/beta/auth-callout/{authCalloutId}/target-accounts: get: description: Get a list of configured Target Accounts operationId: listAuthCalloutTargetAccounts parameters: - explode: false in: path name: authCalloutId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuthCalloutTargetAccountListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Target Account List tags: - auth-callout x-doc-tags: - Auth Callout post: description: Configure a target account operationId: addAuthCalloutTargetAccount parameters: - explode: false in: path name: authCalloutId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthCalloutAddTargetAccountRequest' responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Configure Target Account tags: - auth-callout x-doc-tags: - Auth Callout /core/beta/auth-callout/{authCalloutId}/target-accounts/{targetAccountId}: delete: description: Remove configured target account entry operationId: deleteAuthCalloutTargetAccount parameters: - explode: false in: path name: authCalloutId required: true schema: type: string style: simple - explode: false in: path name: targetAccountId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Target Account tags: - auth-callout x-doc-tags: - Auth Callout /core/beta/auth-callout/{authCalloutId}/users: get: description: Get a list of configured Target Accounts operationId: listAuthCalloutUsers parameters: - explode: false in: path name: authCalloutId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuthCalloutUsersListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Target Account List tags: - auth-callout x-doc-tags: - Auth Callout post: description: Create a Control Account User that can access auth callout operationId: addAuthCalloutUser parameters: - explode: false in: path name: authCalloutId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthCalloutAddUserRequest' responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Auth Callout User tags: - auth-callout x-doc-tags: - Auth Callout /core/beta/auth-callout/{authCalloutId}/users/{acUserId}: delete: description: Remove control account auth callout user operationId: deleteAuthCalloutUser parameters: - explode: false in: path name: authCalloutId required: true schema: type: string style: simple - explode: false in: path name: acUserId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Control Account User tags: - auth-callout x-doc-tags: - Auth Callout /core/beta/authz/check: post: description: Returns applicable policies for calling session and requested service/resource operationId: check requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthzViewRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuthzViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Check Authz Decisions tags: - authz x-doc-tags: - Authorization /core/beta/authz/policies: get: description: Returns a list of configured app policies operationId: listPolicies responses: "200": content: application/json: schema: $ref: '#/components/schemas/PolicyListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Policy List tags: - authz x-doc-tags: - Authorization /core/beta/authz/roles: get: description: Returns a list of configured app roles operationId: listRoles responses: "200": content: application/json: schema: $ref: '#/components/schemas/RoleListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Authz roles List tags: - authz x-doc-tags: - Authorization /core/beta/component-versions: get: description: Get available component versions operationId: getAvailableComponentVersions responses: "200": content: application/json: schema: $ref: '#/components/schemas/AvailableComponentVersionsResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Available Component Versions tags: - component-versions x-doc-tags: - Component Versions post: description: Get available component versions by type operationId: getAvailableComponentVersionsByType requestBody: content: application/json: schema: $ref: '#/components/schemas/AvailableComponentVersionsRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AvailableChartVersions' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Available Component Versions By Type tags: - component-versions x-doc-tags: - Component Versions /core/beta/consumers/pull/{consumerId}: delete: description: Deletes a JetStream pull consumer operationId: deletePullConsumer parameters: - explode: false in: path name: consumerId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Pull Consumer tags: - pull-consumer x-doc-tags: - JetStream get: description: Returns JetStream pull consumer info operationId: getPullConsumerInfo parameters: - explode: false in: path name: consumerId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Pull Consumer tags: - pull-consumer x-doc-tags: - JetStream patch: description: Updates a JetStream consumer operationId: updatePullConsumer parameters: - explode: false in: path name: consumerId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Pull Consumer tags: - pull-consumer x-doc-tags: - JetStream /core/beta/consumers/push/{consumerId}: delete: description: Delete Push Consumer operationId: deletePushConsumer parameters: - explode: false in: path name: consumerId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Push Consumer tags: - push-consumer x-doc-tags: - JetStream get: description: Returns JetStream push consumer info operationId: getPushConsumerInfo parameters: - explode: false in: path name: consumerId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Push Consumer tags: - push-consumer x-doc-tags: - JetStream patch: description: Update Push Consumer operationId: updatePushConsumer parameters: - explode: false in: path name: consumerId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Push Consumer tags: - push-consumer x-doc-tags: - JetStream /core/beta/invitations: get: description: List of pending invitations operationId: listInvitations responses: "200": content: application/json: schema: $ref: '#/components/schemas/InvitationListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List of pending invitations tags: - session x-doc-tags: - Invitations /core/beta/invitations/{teamId}: post: description: Accept or reject team invitation operationId: decideInvitation parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/InvitationDecisionRequest' responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Accept or reject team invitation tags: - session x-doc-tags: - Invitations /core/beta/jetstream/kv-bucket/{streamId}: delete: description: Deletes KV Bucket operationId: deleteKvBucket parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete KV Bucket tags: - kv-bucket x-doc-tags: - "JetStream: KV Buckets" get: description: Returns JetStream KV bucket info operationId: getKvBucket parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSKVBucketViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get KV Bucket tags: - kv-bucket x-doc-tags: - "JetStream: KV Buckets" patch: description: Update KV Bucket operationId: updateKvBucket parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSKVBucketUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSKVBucketViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update KV Bucket tags: - kv-bucket x-doc-tags: - "JetStream: KV Buckets" /core/beta/jetstream/kv-bucket/{streamId}/consumers: get: description: List Consumers operationId: listKvConsumers parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSConsumerInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Consumers tags: - kv-bucket x-doc-tags: - "JetStream: KV Buckets" /core/beta/jetstream/kv-bucket/{streamId}/consumers/pull: post: description: Creates Pull Consumer operationId: createKvPullConsumer parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Pull Consumer tags: - kv-bucket x-doc-tags: - "JetStream: KV Buckets" /core/beta/jetstream/kv-bucket/{streamId}/consumers/push: post: description: Creates Push Consumer operationId: createKvPushConsumer parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Push Consumer tags: - kv-bucket x-doc-tags: - "JetStream: KV Buckets" /core/beta/jetstream/kv-bucket/{streamId}/purge: delete: description: Purges KV Bucket operationId: purgeKvBucket parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Purge KV Bucket tags: - kv-bucket x-doc-tags: - "JetStream: Streams" /core/beta/jetstream/mirror/{streamId}: delete: description: Delete Mirror operationId: deleteMirror parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Mirror tags: - mirror x-doc-tags: - "JetStream: Mirrors" get: description: Get Mirror operationId: getMirror parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSMirrorInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Mirror tags: - mirror x-doc-tags: - "JetStream: Mirrors" patch: description: Update Mirror operationId: updateMirror parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSMirrorConfigRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSMirrorInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Mirror tags: - mirror x-doc-tags: - "JetStream: Mirrors" /core/beta/jetstream/mirror/{streamId}/consumers: get: description: List Consumers operationId: listMirrorConsumers parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSConsumerInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Consumers tags: - mirror x-doc-tags: - "JetStream: Mirrors" /core/beta/jetstream/mirror/{streamId}/consumers/pull: post: description: Create Pull Consumer operationId: createMirrorPullConsumer parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Pull Consumer tags: - mirror x-doc-tags: - "JetStream: Mirrors" /core/beta/jetstream/mirror/{streamId}/consumers/push: post: description: Create Push consumer operationId: createMirrorPushConsumer parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Push consumer tags: - mirror x-doc-tags: - "JetStream: Mirrors" /core/beta/jetstream/mirror/{streamId}/purge: delete: description: Purges Mirror operationId: purgeMirror parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Purge Mirror tags: - mirror x-doc-tags: - "JetStream: Streams" /core/beta/jetstream/object-bucket/{streamId}: delete: description: Deletes Object Bucket operationId: deleteObjectBucket parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Object Bucket tags: - object-bucket x-doc-tags: - "JetStream: Object Buckets" get: description: Returns JetStream Object bucket info operationId: getObjectBucket parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSObjectBucketViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Object Bucket tags: - object-bucket x-doc-tags: - "JetStream: Object Buckets" patch: description: Update Object Bucket operationId: updateObjectBucket parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSObjectBucketUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSObjectBucketViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Object Bucket tags: - object-bucket x-doc-tags: - "JetStream: Object Buckets" /core/beta/jetstream/object-bucket/{streamId}/consumers: get: description: List Consumers operationId: listObjConsumers parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSConsumerInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Consumers tags: - object-bucket x-doc-tags: - "JetStream: Object Buckets" /core/beta/jetstream/object-bucket/{streamId}/consumers/pull: post: description: Creates Pull Consumer operationId: createObjPullConsumer parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Pull Consumer tags: - object-bucket x-doc-tags: - "JetStream: Object Buckets" /core/beta/jetstream/object-bucket/{streamId}/consumers/push: post: description: Creates Push Consumer operationId: createObjPushConsumer parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Push Consumer tags: - object-bucket x-doc-tags: - "JetStream: Object Buckets" /core/beta/jetstream/object-bucket/{streamId}/purge: delete: description: Purges Object Bucket operationId: purgeObjBucket parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Purge Object Bucket tags: - object-bucket x-doc-tags: - "JetStream: Streams" /core/beta/jetstream/stream/{streamId}: delete: description: Deletes Stream operationId: deleteStream parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Stream tags: - stream x-doc-tags: - "JetStream: Streams" get: description: Get Stream operationId: getStreamInfo parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSStreamInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Stream tags: - stream x-doc-tags: - "JetStream: Streams" patch: description: Updates Stream operationId: updateStream parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSStreamConfigRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSStreamInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Stream tags: - stream x-doc-tags: - "JetStream: Streams" /core/beta/jetstream/stream/{streamId}/consumers: get: description: List Consumers operationId: listConsumers parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JSConsumerInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Consumers tags: - stream x-doc-tags: - "JetStream: Consumers" /core/beta/jetstream/stream/{streamId}/consumers/pull: post: description: Creates Pull Consumer operationId: createPullConsumer parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSPullConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Pull Consumer tags: - stream x-doc-tags: - "JetStream: Streams" /core/beta/jetstream/stream/{streamId}/consumers/push: post: description: Create Push Consumer operationId: createPushConsumer parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerConfigRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/JSPushConsumerInfoResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Push Consumer tags: - stream x-doc-tags: - "JetStream: Streams" /core/beta/jetstream/stream/{streamId}/purge: delete: description: Purges Stream operationId: purgeStream parameters: - explode: false in: path name: streamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Purge Stream tags: - stream x-doc-tags: - "JetStream: Streams" /core/beta/license: delete: description: Remove the stored license operationId: deleteLicense responses: "200": content: application/json: schema: $ref: '#/components/schemas/LicenseStatusResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete License tags: - license x-doc-tags: - License get: description: Returns the current license status and entitlements operationId: getLicenseStatus responses: "200": content: application/json: schema: $ref: '#/components/schemas/LicenseStatusResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get License Status tags: - license x-doc-tags: - License put: description: Submit a new license operationId: updateLicense requestBody: content: application/json: schema: $ref: '#/components/schemas/LicenseUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/LicenseStatusResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update License tags: - license x-doc-tags: - License /core/beta/nats-user-issuances/{issuanceId}: get: description: Get a history of all downloads and imports of the given issuance operationId: getNatsUserIssuance parameters: - explode: false in: path name: issuanceId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserIssuanceViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get nats user issuance tags: - issuance x-doc-tags: - NATS User Issuances /core/beta/nats-users/{userId}: delete: description: Deletes a NATS user from an account operationId: deleteNatsUser parameters: - explode: false in: path name: userId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete NATS User tags: - nats-user x-doc-tags: - NATS Users get: description: Returns a NATS user assigned to the account operationId: getNatsUser parameters: - explode: false in: path name: userId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get NATS User tags: - nats-user x-doc-tags: - NATS Users patch: description: Updates NATS User in an account operationId: updateNatsUser parameters: - explode: false in: path name: userId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/NatsUserUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update NATS User tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/app-users: get: description: Returns a list of Team App Users associated with the NATS user operationId: listNatsUserTeamAppUsers parameters: - explode: false in: path name: userId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Team App Users tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/app-users/{teamAppUserId}: delete: description: Unassign a Team App User from a NATS User operationId: unAssignNatsUserTeamAppUser parameters: - explode: false in: path name: userId required: true schema: type: string style: simple - explode: false in: path name: teamAppUserId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Unassign Team App User from NATS User tags: - nats-user x-doc-tags: - NATS Users post: description: Assign a Team App User to a NATS User. This operation is idempotent; if an App User is already assigned to a NATS User the assignment will be updated with the new role operationId: assignNatsUserTeamAppUser parameters: - explode: false in: path name: userId required: true schema: type: string style: simple - explode: false in: path name: teamAppUserId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAssignRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Assign Team App User to NATS User tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/bearer-jwt: post: description: Returns a bearer token a NATS user assigned to the account operationId: downloadNatsUserBearerJwt parameters: - explode: false in: path name: userId required: true schema: type: string style: simple responses: "200": content: text/plain: schema: type: string description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Bearer JWT tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/connections: get: description: List NATs User Connections operationId: listNatsUserConnections parameters: - explode: false in: path name: userId required: true schema: type: string style: simple - explode: true in: query name: sort required: false schema: type: string style: form - explode: true in: query name: cid required: false schema: type: string style: form - explode: true in: query name: state required: false schema: type: string style: form - explode: true in: query name: subject required: false schema: type: string style: form - explode: true in: query name: limit required: false schema: type: number style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserConnectionsListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List NATs User Connections tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/copy: post: description: "Copies the user, changing name and account SK group. Generates\ \ new user NKey" operationId: copyNatsUser parameters: - explode: false in: path name: userId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/NatsUserCopyRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Copy nats user tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/creds: post: description: Returns a creds file for a NATS user assigned to the account operationId: downloadNatsUserCreds parameters: - explode: false in: path name: userId required: true schema: type: string style: simple responses: "200": content: text/plain: schema: type: string description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Creds tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/http-gw-token: post: description: Returns a NATS HTTP Gateway token operationId: downloadNatsUserHttpGwToken parameters: - explode: false in: path name: userId required: true schema: type: string style: simple responses: "201": content: application/json: schema: $ref: '#/components/schemas/NatsUserHTTPGWTokenCreateReply' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get HTTP Gateway Token tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/issuances: get: description: Lists the history of user credential issuances for the user operationId: listNatsUserIssuances parameters: - explode: false in: path name: userId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserIssuancesListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List nats user issuances tags: - nats-user x-doc-tags: - NATS Users /core/beta/nats-users/{userId}/rotate: post: description: Generates new user nkey operationId: rotateNatsUser parameters: - explode: false in: path name: userId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsUserViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Rotate nats user nkey and seed tags: - nats-user x-doc-tags: - NATS Users /core/beta/oidc-providers: get: description: Returns a list of OIDC providers operationId: listOidcProviders responses: "200": content: application/json: schema: $ref: '#/components/schemas/OidcProviderListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List OIDC Providers tags: - oidc-provider x-doc-tags: - OIDC Providers post: description: Creates a new OIDC provider operationId: createOidcProvider requestBody: content: application/json: schema: $ref: '#/components/schemas/OidcProviderAddRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/OidcProviderViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create OIDC Provider tags: - oidc-provider x-doc-tags: - OIDC Providers /core/beta/oidc-providers/{oidcProviderId}: delete: description: Deletes an OIDC provider operationId: deleteOidcProvider parameters: - explode: false in: path name: oidcProviderId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete OIDC Provider tags: - oidc-provider x-doc-tags: - OIDC Providers get: description: Returns an OIDC provider by ID operationId: getOidcProvider parameters: - explode: false in: path name: oidcProviderId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/OidcProviderViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get OIDC Provider tags: - oidc-provider x-doc-tags: - OIDC Providers patch: description: Updates an OIDC provider operationId: updateOidcProvider parameters: - explode: false in: path name: oidcProviderId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/OidcProviderUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/OidcProviderViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update OIDC Provider tags: - oidc-provider x-doc-tags: - OIDC Providers /core/beta/oidc-providers/defaults: get: description: Returns a list of OIDC provider defaults operationId: listOidcDefaultProvider responses: "200": content: application/json: schema: $ref: '#/components/schemas/OidcProviderDefaultsListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List OIDC Provider Defaults tags: - oidc-provider x-doc-tags: - OIDC Providers /core/beta/personal-access-tokens: get: description: Returns a list of Personal Access Tokens operationId: listAppUserAccessTokens responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Personal Access Tokens tags: - session x-doc-tags: - Session post: description: Creates a Personal Access Token operationId: createAppUserAccessToken requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenCreateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Personal Access Token tags: - session x-doc-tags: - Session /core/beta/personal-access-tokens/{tokenId}: delete: description: Delete Personal Access Token operationId: deletePersonalAccessToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Personal Access Token tags: - personal-access-token x-doc-tags: - Session get: description: Get Personal Access Token operationId: getPersonalAccessToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Personal Access Token tags: - personal-access-token x-doc-tags: - Session patch: description: Update Personal Access Token operationId: updatePersonalAccessToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Personal Access Token tags: - personal-access-token x-doc-tags: - Session /core/beta/platform-components/connect: post: description: Connection endpoint for platform components to use. Requires a platform component bearer token operationId: platformComponentConnect parameters: - explode: false in: path name: id required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/PlatformComponentsConnectRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/PlatformComponentsConnectViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Connect a Platform Component tags: - platform-components x-doc-tags: - Platform Components /core/beta/service-account-tokens/app/{tokenId}: delete: description: Delete App Service Account Token operationId: deleteAppServiceAccountToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete App Service Account Token tags: - app-service-account-tokens x-doc-tags: - App Service Accounts get: description: Get App Service Account Token operationId: getAppServiceAccountToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get App Service Account Token tags: - app-service-account-tokens x-doc-tags: - App Service Accounts patch: description: Update App Service Account Token operationId: updateAppServiceAccountToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update App Service Account Token tags: - app-service-account-tokens x-doc-tags: - App Service Accounts /core/beta/service-account-tokens/team/{tokenId}: delete: description: Delete Team Service Account Token operationId: deleteTeamServiceAccountToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Team Service Account Token tags: - team-service-account-tokens x-doc-tags: - Team Service Accounts get: description: Get Team Service Account Token operationId: getTeamServiceAccountToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Team Service Account Token tags: - team-service-account-tokens x-doc-tags: - Team Service Accounts patch: description: Update Team Service Account Token operationId: updateTeamServiceAccountToken parameters: - explode: false in: path name: tokenId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Team Service Account Token tags: - team-service-account-tokens x-doc-tags: - Team Service Accounts /core/beta/service-accounts/app: get: description: List App Service Accounts operationId: listAppServiceAccounts responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServiceAccountListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List App Service Accounts tags: - session x-doc-tags: - App Service Accounts post: description: Create App Service Account operationId: createAppServiceAccount requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceAccountCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServiceAccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create App Service Account tags: - session x-doc-tags: - App Service Accounts /core/beta/service-accounts/app/{serviceAccountId}: delete: description: Delete App Service Account operationId: deleteAppServiceAccount parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete App Service Account tags: - app-service-account x-doc-tags: - App Service Accounts get: description: Get App Service Account operationId: getAppServiceAccount parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServiceAccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get App Service Account tags: - app-service-account x-doc-tags: - App Service Accounts patch: description: Update App Service Account operationId: updateAppServiceAccount parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceAccountUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServiceAccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update App Service Account tags: - app-service-account x-doc-tags: - App Service Accounts /core/beta/service-accounts/app/{serviceAccountId}/tokens: get: description: List Access Tokens for App Service Account operationId: listAppServiceAccountTokens parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Access Tokens for App Service Account tags: - app-service-account x-doc-tags: - App Service Accounts post: description: Create Acess Token for App Service Account operationId: createAppServiceAccountToken parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenCreateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Acess Token for App Service Account tags: - app-service-account x-doc-tags: - App Service Accounts /core/beta/service-accounts/team/{serviceAccountId}: delete: description: Delete Team Service Account operationId: deleteTeamServiceAccount parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Team Service Account tags: - team-service-account x-doc-tags: - Team Service Accounts get: description: Get Team Service Account operationId: getTeamServiceAccount parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServiceAccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Team Service Account tags: - team-service-account x-doc-tags: - Team Service Accounts patch: description: Update Team Service Account operationId: updateTeamServiceAccount parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceAccountUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServiceAccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Team Service Account tags: - team-service-account x-doc-tags: - Team Service Accounts /core/beta/service-accounts/team/{serviceAccountId}/tokens: get: description: List Access Tokens for Team Service Account operationId: listTeamServiceAccountTokens parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Access Tokens for Team Service Account tags: - team-service-account x-doc-tags: - Team Service Accounts post: description: Create Acess Token for Team Service Account operationId: createTeamServiceAccountToken parameters: - explode: false in: path name: serviceAccountId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAccessTokenCreateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Acess Token for Team Service Account tags: - team-service-account x-doc-tags: - Team Service Accounts /core/beta/stream-exports/{streamExportId}: delete: description: Delete Stream Export operationId: deleteStreamExport parameters: - explode: false in: path name: streamExportId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Stream Export tags: - stream-export x-doc-tags: - Sharing get: description: Returns Stream Export info operationId: getStreamExport parameters: - explode: false in: path name: streamExportId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/StreamExportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Stream Export tags: - stream-export x-doc-tags: - Sharing /core/beta/stream-exports/{streamExportId}/shares: get: description: List stream shares for this export operationId: listStreamShares parameters: - explode: false in: path name: streamExportId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/StreamShareListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Stream Shares tags: - stream-export x-doc-tags: - Sharing post: description: Creates Stream Shares operationId: createStreamShares parameters: - explode: false in: path name: streamExportId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/StreamShareCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/StreamShareViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Stream Shares tags: - stream-export x-doc-tags: - Sharing /core/beta/stream-exports/{streamExportId}/shares/{targetAccountNKeyPublic}: delete: description: Revokes the share for provided Account NKey operationId: deleteStreamShare parameters: - explode: false in: path name: streamExportId required: true schema: type: string style: simple - explode: false in: path name: targetAccountNKeyPublic required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Stream Share tags: - stream-export x-doc-tags: - Sharing /core/beta/stream-imports/{streamImportId}: delete: description: Delete Stream Import operationId: deleteStreamImport parameters: - explode: false in: path name: streamImportId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Stream Import tags: - stream-import x-doc-tags: - Sharing get: description: Returns Stream Import operationId: getStreamImport parameters: - explode: false in: path name: streamImportId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/StreamImportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Stream Import tags: - stream-import x-doc-tags: - Sharing /core/beta/subject-exports/{subjectExportId}: delete: description: Delete Subject Export operationId: deleteSubjectExport parameters: - explode: false in: path name: subjectExportId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Subject Export tags: - subject-export x-doc-tags: - Sharing get: description: Returns Subject Export info operationId: getSubjectExport parameters: - explode: false in: path name: subjectExportId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SubjectExportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Subject Export tags: - subject-export x-doc-tags: - Sharing patch: description: Update Subject Export operationId: updateSubjectExport parameters: - explode: false in: path name: subjectExportId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SubjectExportUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/SubjectExportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Subject Export tags: - subject-export x-doc-tags: - Sharing /core/beta/subject-exports/{subjectExportId}/shares: get: description: List subject shares for this export operationId: listSubjectShares parameters: - explode: false in: path name: subjectExportId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SubjectShareListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Subject Shares tags: - subject-export x-doc-tags: - Sharing post: description: Creates Subject Shares operationId: createSubjectShares parameters: - explode: false in: path name: subjectExportId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SubjectShareCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/SubjectShareViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Subject Shares tags: - subject-export x-doc-tags: - Sharing /core/beta/subject-exports/{subjectExportId}/shares/{targetAccountNKeyPublic}: delete: description: Revokes the share for account operationId: deleteSubjectShare parameters: - explode: false in: path name: subjectExportId required: true schema: type: string style: simple - explode: false in: path name: targetAccountNKeyPublic required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Subject Share tags: - subject-export x-doc-tags: - Sharing /core/beta/subject-imports/{subjectImportId}: delete: description: Delete Subject Import operationId: deleteSubjectImport parameters: - explode: false in: path name: subjectImportId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Subject Import tags: - subject-import x-doc-tags: - Sharing get: description: Returns Subject Import operationId: getSubjectImport parameters: - explode: false in: path name: subjectImportId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SubjectImportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Subject Import tags: - subject-import x-doc-tags: - Sharing patch: description: Updates Subject Import operationId: updateSubjectImport parameters: - explode: false in: path name: subjectImportId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SubjectImportUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/SubjectImportViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Subject Import tags: - subject-import x-doc-tags: - Sharing /core/beta/systems/{systemId}: delete: description: Deletes System operationId: deleteSystem parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete System tags: - system x-doc-tags: - Systems get: description: Returns a System by ID operationId: getSystem parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SystemViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get System tags: - system x-doc-tags: - Systems patch: description: Updates a System operationId: updateSystem parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - description: "To test the backend connection without updating the system,\ \ pass test_connection=true in query parameter." explode: true in: query name: test_connection required: false schema: type: boolean style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/SystemUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/SystemViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update System tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/accounts: get: description: List Accounts operationId: listAccounts parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AccountListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Accounts tags: - system x-doc-tags: - Accounts post: description: Create Account operationId: createAccount parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountCreateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/AccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Account tags: - system x-doc-tags: - Accounts /core/beta/systems/{systemId}/accounts-overview-metrics: get: description: List Accounts overview metrics operationId: listAccountsOverviewMetrics parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AccountsOverviewListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Accounts overview metrics tags: - system x-doc-tags: - Accounts /core/beta/systems/{systemId}/agent-tokens: get: description: List Agent Tokens operationId: listAgentTokens parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AgentTokenListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Agent Tokens tags: - system x-doc-tags: - Accounts post: description: Rotate token to connect a dataplane agent operationId: rotateAgentToken parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AgentTokenRotateRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/AgentTokenRotateResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Rotate Agent Token tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/agent-tokens/current: get: description: Get the Current Agent Token operationId: getCurrentAgentToken parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "201": content: application/json: schema: $ref: '#/components/schemas/AgentTokenCurrentResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Current Agent Token tags: - system x-doc-tags: - App Users /core/beta/systems/{systemId}/alert-rules: get: description: List System Alert Rules operationId: listSystemAlertRules parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertRuleListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List System Alert Rules tags: - system x-doc-tags: - Alerts post: description: Create System Alert Rule operationId: createSystemAlertRule parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRuleSystemCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertRuleViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create System Alert Rule tags: - system x-doc-tags: - Alerts /core/beta/systems/{systemId}/alert-rules/{alertRuleId}: delete: description: Delete System Alert rule operationId: deleteSystemAlertRule parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: alertRuleId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete System Alert Rule tags: - system x-doc-tags: - Alerts get: description: Get System Alert Rule operationId: getSystemAlertRule parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: alertRuleId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertRuleViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get System Alert Rule tags: - system x-doc-tags: - Alerts patch: description: Update System Alert Rules operationId: updateSystemAlertRule parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: alertRuleId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertRuleUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertRuleViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update System Alert Rules tags: - system x-doc-tags: - Alerts /core/beta/systems/{systemId}/alert-rules/{alertRuleId}/run: get: description: Run System Alert Rule and return an alert object if the rule condition is met operationId: runSystemAlertRule parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: alertRuleId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AlertViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Run System Alert Rule tags: - system x-doc-tags: - Alerts /core/beta/systems/{systemId}/app-users: get: description: Returns a list of Team App Users associated with the System operationId: listSystemTeamAppUsers parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List System Team App Users tags: - system x-doc-tags: - App Users /core/beta/systems/{systemId}/app-users/{teamAppUserId}: delete: description: Unassign a Team App User from a System operationId: unAssignSystemTeamAppUser parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: teamAppUserId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Unassign Team App User from System tags: - system x-doc-tags: - App Users post: description: Assign a Team App User to a System. This operation is idempotent; if an App User is already assigned to the System the assignment will be updated with the new role operationId: assignSystemTeamAppUser parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: teamAppUserId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAssignRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Assign Team App User to System tags: - system x-doc-tags: - App Users /core/beta/systems/{systemId}/audit/jobs: get: description: "Returns a list of recent audit jobs for the system, ordered by\ \ creation time (most recent first)" operationId: listSystemAuditJobs parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuditJobListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Audit Jobs tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/audit/jobs/{jobId}: get: description: Returns the current status of an asynchronous audit job operationId: getSystemAuditJobStatus parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: jobId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuditJobResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Audit Job Status tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/audit/jobs/{jobId}/result: get: description: Returns the analyzed audit results for a completed job operationId: getSystemAuditJobResult parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: jobId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuditHealthResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Audit Job Result tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/audit/run: post: description: Starts an asynchronous system audit check and returns job tracking information operationId: runSystemAuditCheck parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AuditJobRequest' responses: "202": content: application/json: schema: $ref: '#/components/schemas/AuditJobResponse' description: Accepted "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Run System Audit Check tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/auth-callout: get: description: List Auth Callout Configs for the System operationId: listAuthCalloutConfigs parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuthCalloutConfigListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Auth Callout Configs tags: - system x-doc-tags: - Systems post: description: Saves an auth callout config for the system operationId: enableAuthCallout parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthCalloutEnableRequest' responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Enable Auth Callout For System tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/auth-callout/authenticators: get: description: Get a list of authenticators available for use operationId: listAuthCalloutAuthenticators parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AuthCalloutAuthenticatorsListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get List of Available Authenticators tags: - system x-doc-tags: - Auth Callout /core/beta/systems/{systemId}/bulk/shares: post: description: allows sharing streams/exports across multiple accounts at once operationId: bulkShare parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkShareRequest' responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Share assets across accounts tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/connections: get: description: List Connections operationId: listConnections parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: true in: query name: sort required: false schema: type: string style: form - explode: true in: query name: account required: false schema: type: string style: form - explode: true in: query name: cid required: false schema: type: string style: form - explode: true in: query name: state required: false schema: type: string style: form - explode: true in: query name: subject required: false schema: type: string style: form - explode: true in: query name: limit required: false schema: type: number style: form - explode: true in: query name: user required: false schema: type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/SystemConnectionsListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Connections tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/export: get: description: Export System Seeds operationId: getSystemExport parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SystemExportResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Export System Seeds tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/health/check: get: description: "Returns overall health status of all servers in the system, similar\ \ to 'nats server report health'" operationId: getSystemHealthCheck parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/HealthCheckResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get System Health Check tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/health/clusters: get: description: Returns cluster-level aggregated metrics and status information operationId: getSystemHealthClusters parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/ClusterOverviewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Cluster Overview tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/health/jetstream: get: description: "Returns JetStream health and usage statistics across all servers,\ \ similar to 'nats server report jetstream'" operationId: getSystemHealthJetstream parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/JetStreamReportResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get JetStream Health Report tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/health/servers: get: description: "Returns a list of all NATS servers in the system with their current\ \ status, similar to 'nats server ls'" operationId: getSystemHealthServers parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServerListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get System Server List tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/import-account: post: description: Imports an existing account operationId: importAccount parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SystemAccountImportRequest' responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Import Account tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/import-user: post: description: Imports an existing NATS user operationId: importUser parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SystemUserImportRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/NatsUserViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Import User tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/info/accounts: get: description: List info for Accounts within a System. Allows a user with access to a single account in a system to list info for all accounts in that system operationId: listSystemInfoAccounts parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AccountInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List System Accounts Info tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/info/servers: get: description: List info for NATS Servers within a System operationId: listSystemInfoServers parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsServerInfoListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List System Servers info tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/jwt-sync: post: description: Use this endpoint to re-issue all JWTs. This endpoint just marks all account JWTs for renewal. The actual renewal takes place asynchronously and may take a while depending on the number of accounts. operationId: systemJWTSync parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Re-sync JWTs of all accounts in this system tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/limits: get: description: Get system total and allocated limits operationId: getSystemLimits parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SystemLimitsResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get System Limits tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/nats-clusters: get: description: List cluster information operationId: listClusters parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsClusterListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Clusters tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/platform-components: patch: description: Update the different platform components config operationId: updatePlatformComponents parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/PlatformComponentsUpdateRequest' responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Platform Components for System tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/platform-components/{id}/tokens: get: description: Retrieves an access token for the platform component operationId: getComponentToken parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple - explode: false in: path name: id required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/PlatformComponentTokenViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get a component access token tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/prometheus-metrics: get: description: Get Prometheus Metrics operationId: getSystemPrometheusMetrics parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: text/plain: schema: type: string description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Prometheus Metrics tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/servers: get: description: List server information operationId: listServers parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/NatsServerListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Servers tags: - system x-doc-tags: - Systems /core/beta/systems/{systemId}/unmanage: delete: description: Same as deleting a system but skips purging system and accounts from NATS operationId: unmanageSystem parameters: - explode: false in: path name: systemId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Unmanage System tags: - system x-doc-tags: - Systems /core/beta/teams: get: description: Returns a list of Teams operationId: listTeams parameters: - explode: true in: query name: assigned required: false schema: type: string style: form responses: "200": content: application/json: schema: $ref: '#/components/schemas/TeamListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Teams tags: - session x-doc-tags: - Teams post: description: Create a Team operationId: createTeam requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/TeamViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Team tags: - session x-doc-tags: - Teams /core/beta/teams/{teamId}: delete: description: Deletes Team operationId: deleteTeam parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Delete Team tags: - team x-doc-tags: - Teams get: description: Returns a Team by ID operationId: getTeam parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/TeamViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Team tags: - team x-doc-tags: - Teams patch: description: Updates a Team operationId: updateTeam parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamUpdateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/TeamViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update Team tags: - team x-doc-tags: - Teams /core/beta/teams/{teamId}/app-users: get: description: Returns a list of App Users associated with the Team operationId: listTeamAppUsers parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List App Users tags: - team x-doc-tags: - App Users /core/beta/teams/{teamId}/app-users/{appUserId}: delete: description: Unassign an App User from a Team operationId: unAssignTeamAppUser parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple - explode: false in: path name: appUserId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Unassign App User from Team tags: - team x-doc-tags: - App Users patch: description: Update an App User's assignment on a Team operationId: updateTeamAppUser parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple - explode: false in: path name: appUserId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserAssignRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserAssignResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Update App User Team Assignment tags: - team x-doc-tags: - App Users /core/beta/teams/{teamId}/app-users/invitations: post: description: "Invites the specified User to join the Team. This operation is\ \ idempotent, with the caveat that Roles will not be downgraded; if the User\ \ is already assigned to the Team or Associated Resources and the requested\ \ Role is more permissive than the existing Role, the Role will be updated." operationId: inviteAppUser parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AppUserInvitationRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/AppUserInvitationResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Invite App Users tags: - team x-doc-tags: - Invitations /core/beta/teams/{teamId}/app-users/leave: post: description: Leave the specified team operationId: leaveTeam parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple responses: "204": description: No Content "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Leave Team tags: - team x-doc-tags: - Session /core/beta/teams/{teamId}/import-system: post: description: Import a System operationId: importSystem parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SystemImportRequest' responses: "201": content: application/json: schema: $ref: '#/components/schemas/SystemViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Import a System tags: - team x-doc-tags: - Teams /core/beta/teams/{teamId}/info/app-users: get: description: List info for App Users in Team. Allows any user to list info for app users within their team. operationId: listTeamInfoAppUsers parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/TeamAppUserListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List info of App Users in Team tags: - team x-doc-tags: - Teams /core/beta/teams/{teamId}/service-accounts: get: description: List Team Service Accounts operationId: listTeamServiceAccounts parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServiceAccountListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Team Service Accounts tags: - team x-doc-tags: - Teams post: description: Create Team Service Account operationId: createTeamServiceAccount parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceAccountCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/ServiceAccountViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create Team Service Account tags: - team x-doc-tags: - Teams /core/beta/teams/{teamId}/systems: get: description: Returns a list of Systems operationId: listTeamSystems parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/SystemListResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Systems tags: - team x-doc-tags: - Systems post: description: Create a System operationId: createSystem parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SystemCreateRequest' responses: "200": content: application/json: schema: $ref: '#/components/schemas/SystemViewResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Create System tags: - team x-doc-tags: - Systems /core/beta/teams/{teamId}/team-limits: get: description: Get team limits total and allocated operationId: getTeamLimits parameters: - explode: false in: path name: teamId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/TeamLimitsResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Team Limits tags: - team x-doc-tags: - Teams /core/beta/terms/accept: post: description: Accept terms operationId: acceptTerms responses: "201": content: application/json: schema: $ref: '#/components/schemas/AcceptTermsResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Accept terms tags: - session x-doc-tags: - Session /core/beta/version: get: description: Returns information about the Synadia Control Plane Version operationId: getVersion responses: "200": content: application/json: schema: $ref: '#/components/schemas/VersionResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Version tags: - session x-doc-tags: - Session /workloads/alpha/{accountId}/limits: get: description: Get Workloads limits operationId: getWorkloadLimits parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/WorkloadLimitsResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: Get Workloads limits tags: - workloads x-doc-tags: - Workloads /workloads/alpha/{accountId}/tags: get: description: List Workload tags operationId: listWorkloadTags parameters: - explode: false in: path name: accountId required: true schema: type: string style: simple responses: "200": content: application/json: schema: $ref: '#/components/schemas/WorkloadTagsResponse' description: Success "400": description: Bad Request "401": description: Unauthorized "403": description: Forbidden "404": description: Not Found summary: List Workload tags tags: - workloads x-doc-tags: - Workloads components: schemas: AcceptTermsResponse: example: ip_address: ip_address accepted_at: 2000-01-23T04:56:07.000+00:00 properties: accepted_at: format: date-time type: string ip_address: type: string required: - accepted_at - ip_address type: object Account: allOf: - $ref: '#/components/schemas/Info' - $ref: '#/components/schemas/GenericFields' description: Account holds account specific claims data example: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey default_permissions: sub: allow: - allow - allow deny: - deny - deny resp: max: 0 ttl: 6 pub: allow: - allow - allow deny: - deny - deny mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 imports: - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token revocations: key: 1 exports: - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 signing_keys: null limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 properties: authorization: $ref: '#/components/schemas/ExternalAuthorization' default_permissions: $ref: '#/components/schemas/Permissions' exports: description: Exports is a slice of exports items: $ref: '#/components/schemas/Export' type: array imports: description: Imports is a list of import structs items: $ref: '#/components/schemas/Import' type: array limits: $ref: '#/components/schemas/OperatorLimits' mappings: additionalProperties: items: $ref: '#/components/schemas/WeightedMapping' type: array type: object revocations: additionalProperties: format: int64 type: integer description: RevocationList is used to store a mapping of public keys to unix timestamps type: object signing_keys: $ref: '#/components/schemas/SigningKeys' type: object AccountAssignment: example: account_id: account_id role: role account_name: account_name properties: account_id: type: string account_name: type: string role: type: string required: - account_id - role type: object AccountAuthType: enum: - jwt - tls - nkey - username type: string AccountChartType: enum: - NumLeafNodes - NumConnections - NumSubscriptions - BytesSent - BytesReceived - NumMessagesSent - NumMessagesReceived - JetStreamEnabled - NumStreams - NumStreamConsumers - JetStreamMemoryUsed - JetStreamStorageUsed - JetStreamMemoryReserved - JetStreamStorageReserved type: string AccountClaims: allOf: - $ref: '#/components/schemas/ClaimsData' description: AccountClaims defines the body of an account JWT example: nats: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey default_permissions: sub: allow: - allow - allow deny: - deny - deny resp: max: 0 ttl: 6 pub: allow: - allow - allow deny: - deny - deny mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 imports: - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token revocations: key: 1 exports: - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 signing_keys: null limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 properties: nats: $ref: '#/components/schemas/Account' type: object AccountClaimsInfo: example: js_enabled: true properties: js_enabled: type: boolean required: - js_enabled type: object AccountConnectionsListResponse: example: items: - total: 5 offset: 1 now: 2000-01-23T04:56:07.000+00:00 limit: 0 num_connections: 6 server_id: server_id connections: - null - null - total: 5 offset: 1 now: 2000-01-23T04:56:07.000+00:00 limit: 0 num_connections: 6 server_id: server_id connections: - null - null properties: items: items: $ref: '#/components/schemas/Connz' type: array required: - items type: object AccountCreateRequest: example: user_secret: user_secret auth_type: null connectors: true connectors_log_stream: connectors_log_stream jwt_settings: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 revocations: key: 6 limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 tags: - tags - tags user_cred: user_cred name: name workloads: true user_jwt_expires_in_secs: 0 workloads_log_stream: workloads_log_stream properties: auth_type: $ref: '#/components/schemas/AccountAuthType' connectors: type: boolean connectors_log_stream: type: string jwt_settings: $ref: '#/components/schemas/AccountJWTSettings' name: type: string user_cred: type: string user_jwt_expires_in_secs: format: int64 type: integer user_secret: type: string workloads: type: boolean workloads_log_stream: type: string required: - name type: object AccountExportResponse: example: seed: seed jwt: jwt name: name signing_key_groups: - name: name signing_keys: - seed: seed id: id - seed: seed id: id - name: name signing_keys: - seed: seed id: id - seed: seed id: id id: id users: - seed: seed jwt: jwt name: name id: id - seed: seed jwt: jwt name: name id: id properties: id: type: string jwt: type: string name: type: string seed: type: string signing_key_groups: items: $ref: '#/components/schemas/SigningKeyGroupExport' type: array users: items: $ref: '#/components/schemas/UserExport' type: array required: - id type: object AccountInfo: example: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true properties: account_public_key: type: string auth_type: $ref: '#/components/schemas/AccountAuthType' id: type: string is_platform_account: type: boolean is_scp_account: type: boolean is_system_account: type: boolean name: type: string user_cred: type: string user_jwt: type: string user_jwt_expires_in_secs: format: int64 type: integer required: - auth_type - id - is_platform_account - is_scp_account - is_system_account - name - user_jwt_expires_in_secs type: object AccountInfoListResponse: example: items: - user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true - user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true properties: items: items: $ref: '#/components/schemas/AccountInfo' type: array required: - items type: object AccountJWTSettings: allOf: - $ref: '#/components/schemas/Info' example: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 revocations: key: 6 limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 tags: - tags - tags properties: authorization: $ref: '#/components/schemas/ExternalAuthorization' limits: $ref: '#/components/schemas/OperatorLimits' mappings: additionalProperties: items: $ref: '#/components/schemas/WeightedMapping' type: array type: object revocations: additionalProperties: format: int64 type: integer description: RevocationList is used to store a mapping of public keys to unix timestamps type: object tags: items: type: string type: array type: object AccountJWTSettingsPatch: example: authorization: null mappings: "{}" revocations: "{}" description: description info_url: info_url limits: null tags: - tags - tags properties: authorization: $ref: '#/components/schemas/AccountJWTSettingsPatch_authorization' description: nullable: true type: string info_url: nullable: true type: string limits: $ref: '#/components/schemas/AccountJWTSettingsPatch_limits' mappings: allOf: - $ref: '#/components/schemas/MappingPatch' nullable: true type: object revocations: allOf: - $ref: '#/components/schemas/RevocationListPatch' nullable: true type: object tags: items: type: string nullable: true type: array type: object AccountLimits: properties: conn: format: int64 type: integer disallow_bearer: type: boolean exports: format: int64 type: integer imports: format: int64 type: integer leaf: format: int64 type: integer wildcards: type: boolean type: object AccountListResponse: example: items: - jwt_sync_error: jwt_sync_error auth_type: null connectors: true created: 2000-01-23T04:56:07.000+00:00 jwt: jwt account_public_key: account_public_key workloads: true user_jwt_expires_in_secs: 7 team: name: name id: id nsc_managed: true is_scp_account: true is_system_account: true claims_info: js_enabled: true user_jwt: user_jwt connectors_log_stream: connectors_log_stream system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain jwt_sync_status: null jwt_settings: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 revocations: key: 6 limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 tags: - tags - tags user_cred: user_cred claims: nats: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey default_permissions: sub: allow: - allow - allow deny: - deny - deny resp: max: 0 ttl: 6 pub: allow: - allow - allow deny: - deny - deny mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 imports: - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token revocations: key: 1 exports: - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 signing_keys: null limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 name: name workloads_log_stream: workloads_log_stream id: id is_platform_account: true - jwt_sync_error: jwt_sync_error auth_type: null connectors: true created: 2000-01-23T04:56:07.000+00:00 jwt: jwt account_public_key: account_public_key workloads: true user_jwt_expires_in_secs: 7 team: name: name id: id nsc_managed: true is_scp_account: true is_system_account: true claims_info: js_enabled: true user_jwt: user_jwt connectors_log_stream: connectors_log_stream system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain jwt_sync_status: null jwt_settings: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 revocations: key: 6 limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 tags: - tags - tags user_cred: user_cred claims: nats: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey default_permissions: sub: allow: - allow - allow deny: - deny - deny resp: max: 0 ttl: 6 pub: allow: - allow - allow deny: - deny - deny mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 imports: - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token revocations: key: 1 exports: - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 signing_keys: null limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 name: name workloads_log_stream: workloads_log_stream id: id is_platform_account: true properties: items: items: $ref: '#/components/schemas/AccountViewResponse' type: array required: - items type: object AccountMetrics: example: nats_core_account_bytes_sent: 6.027456183070403 nats_core_account_jetstream_enabled: 5.637376656633329 nats_core_account_jetstream_memory_used: 7.061401241503109 nats_core_account_jetstream_storage_used: 3.616076749251911 nats_core_account_leaf_count: 4.145608029883936 nats_core_account_jetstream_memory_reserved: 2.3021358869347655 nats_core_account_bytes_recv: 0.8008281904610115 nats_core_account_jetstream_storage_reserved: 9.301444243932576 nats_core_account_msgs_recv: 7.386281948385884 nats_core_account_conn_count: 1.4658129805029452 nats_core_account_jetstream_consumer_count: 5.962133916683182 nats_core_account_jetstream_stream_count: 2.027123023002322 nats_core_account_sub_count: 1.0246457001441578 nats_core_account_msgs_sent: 1.2315135367772556 properties: nats_core_account_bytes_recv: format: double type: number nats_core_account_bytes_sent: format: double type: number nats_core_account_conn_count: format: double type: number nats_core_account_jetstream_consumer_count: format: double type: number nats_core_account_jetstream_enabled: format: double type: number nats_core_account_jetstream_memory_reserved: format: double type: number nats_core_account_jetstream_memory_used: format: double type: number nats_core_account_jetstream_storage_reserved: format: double type: number nats_core_account_jetstream_storage_used: format: double type: number nats_core_account_jetstream_stream_count: format: double type: number nats_core_account_leaf_count: format: double type: number nats_core_account_msgs_recv: format: double type: number nats_core_account_msgs_sent: format: double type: number nats_core_account_sub_count: format: double type: number required: - nats_core_account_bytes_recv - nats_core_account_bytes_sent - nats_core_account_conn_count - nats_core_account_jetstream_consumer_count - nats_core_account_jetstream_enabled - nats_core_account_jetstream_memory_reserved - nats_core_account_jetstream_memory_used - nats_core_account_jetstream_storage_reserved - nats_core_account_jetstream_storage_used - nats_core_account_jetstream_stream_count - nats_core_account_leaf_count - nats_core_account_msgs_recv - nats_core_account_msgs_sent - nats_core_account_sub_count type: object AccountOverviewResponse: example: account_public_key: account_public_key metrics: JetStreamR1StorageUsed: 1.4658129805029452 BytesReceived: 0.8008281904610115 NumLeafNodes: 2.3021358869347655 NumConnections: 5.637376656633329 NumMessagesSent: 9.301444243932576 BytesSent: 6.027456183070403 JetStreamR3StorageUsed: 5.962133916683182 NumMessagesReceived: 7.061401241503109 properties: account_public_key: type: string metrics: $ref: '#/components/schemas/AccountOverviewResponse_metrics' required: - account_public_key - metrics type: object AccountUpdateRequest: example: user_secret: user_secret auth_type: null connectors: true connectors_log_stream: connectors_log_stream jwt_settings: authorization: null mappings: "{}" revocations: "{}" description: description info_url: info_url limits: null tags: - tags - tags user_cred: user_cred name: name workloads: true user_jwt_expires_in_secs: 0 workloads_log_stream: workloads_log_stream properties: auth_type: $ref: '#/components/schemas/AccountAuthType' connectors: type: boolean connectors_log_stream: type: string jwt_settings: $ref: '#/components/schemas/AccountJWTSettingsPatch' name: type: string user_cred: type: string user_jwt_expires_in_secs: format: int64 type: integer user_secret: type: string workloads: type: boolean workloads_log_stream: type: string type: object AccountViewResponse: example: jwt_sync_error: jwt_sync_error auth_type: null connectors: true created: 2000-01-23T04:56:07.000+00:00 jwt: jwt account_public_key: account_public_key workloads: true user_jwt_expires_in_secs: 7 team: name: name id: id nsc_managed: true is_scp_account: true is_system_account: true claims_info: js_enabled: true user_jwt: user_jwt connectors_log_stream: connectors_log_stream system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain jwt_sync_status: null jwt_settings: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 revocations: key: 6 limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 tags: - tags - tags user_cred: user_cred claims: nats: authorization: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey default_permissions: sub: allow: - allow - allow deny: - deny - deny resp: max: 0 ttl: 6 pub: allow: - allow - allow deny: - deny - deny mappings: key: - cluster: cluster subject: subject weight: 26 - cluster: cluster subject: subject weight: 26 imports: - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token - local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token revocations: key: 1 exports: - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 - revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 signing_keys: null limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 name: name workloads_log_stream: workloads_log_stream id: id is_platform_account: true properties: account_public_key: type: string auth_type: $ref: '#/components/schemas/AccountAuthType' claims: $ref: '#/components/schemas/AccountClaims' claims_info: $ref: '#/components/schemas/AccountClaimsInfo' connectors: type: boolean connectors_log_stream: type: string created: format: date-time type: string id: type: string is_platform_account: type: boolean is_scp_account: type: boolean is_system_account: type: boolean jwt: type: string jwt_settings: $ref: '#/components/schemas/AccountJWTSettings' jwt_sync_error: type: string jwt_sync_status: $ref: '#/components/schemas/JwtSyncStatus' name: type: string nsc_managed: type: boolean system: $ref: '#/components/schemas/SystemInfo' team: $ref: '#/components/schemas/TeamInfo' user_cred: type: string user_jwt: type: string user_jwt_expires_in_secs: format: int64 type: integer workloads: type: boolean workloads_log_stream: type: string required: - auth_type - connectors - created - id - is_platform_account - is_scp_account - is_system_account - jwt_sync_error - jwt_sync_status - name - nsc_managed - system - team - user_jwt_expires_in_secs - workloads type: object AccountsOverviewListResponse: example: items: - account_public_key: account_public_key metrics: JetStreamR1StorageUsed: 1.4658129805029452 BytesReceived: 0.8008281904610115 NumLeafNodes: 2.3021358869347655 NumConnections: 5.637376656633329 NumMessagesSent: 9.301444243932576 BytesSent: 6.027456183070403 JetStreamR3StorageUsed: 5.962133916683182 NumMessagesReceived: 7.061401241503109 - account_public_key: account_public_key metrics: JetStreamR1StorageUsed: 1.4658129805029452 BytesReceived: 0.8008281904610115 NumLeafNodes: 2.3021358869347655 NumConnections: 5.637376656633329 NumMessagesSent: 9.301444243932576 BytesSent: 6.027456183070403 JetStreamR3StorageUsed: 5.962133916683182 NumMessagesReceived: 7.061401241503109 properties: items: items: $ref: '#/components/schemas/AccountOverviewResponse' type: array required: - items type: object AckPolicy: description: enums have been changed to match UnmarshalJSON in https://github.com/nats-io/jsm.go/blob/main/api/consumers.go enum: - none - all - explicit - flow_control type: string Activation: allOf: - $ref: '#/components/schemas/GenericFields' description: Activation defines the custom parts of an activation claim example: kind: null subject: subject issuer_account: issuer_account properties: issuer_account: description: |- IssuerAccount stores the public key for the account the issuer represents. When set, the claim was issued by a signing key. type: string kind: $ref: '#/components/schemas/ExportType' subject: type: string type: object ActivationClaims: allOf: - $ref: '#/components/schemas/ClaimsData' description: ActivationClaims holds the data specific to an activation JWT example: nats: kind: null subject: subject issuer_account: issuer_account properties: nats: $ref: '#/components/schemas/Activation' type: object AddRequest: properties: compat_policy: description: |- SchemaCompatPolicy represents the compatibility policy for schema evolution. Supported values are "none", "backwards", "forward", and "full". type: string definition: description: |- TODO(jrm): we should validate the passed schema The schema definition (required). type: string description: description: Description of the schema (optional). type: string format: description: |- SchemaFormat represents the format of a schema definition. Supported values are "jsonschema". type: string metadata: additionalProperties: type: string description: Metadata is a map of key-value pairs (optional). type: object name: description: "Unique name of the schema (set from subject, not from JSON\ \ payload)." type: string required: - definition - format type: object AddResponse: properties: revision: type: integer version: type: integer required: - revision - version type: object AdminAppUserCreateRequest: example: password: password generate_token: true username: username properties: generate_token: type: boolean password: type: string username: type: string required: - password - username type: object AdminAppUserCreateResponse: example: token: token properties: token: type: string type: object AgentTokenCurrentResponse: allOf: - $ref: '#/components/schemas/AgentTokenViewResponse' - required: - token - url example: url: url token: token properties: token: type: string url: type: string type: object AgentTokenListResponse: example: items: - nkey_public: nkey_public created: 2000-01-23T04:56:07.000+00:00 id: id last_accessed_at: 2000-01-23T04:56:07.000+00:00 is_current: true rotated_at: 2000-01-23T04:56:07.000+00:00 - nkey_public: nkey_public created: 2000-01-23T04:56:07.000+00:00 id: id last_accessed_at: 2000-01-23T04:56:07.000+00:00 is_current: true rotated_at: 2000-01-23T04:56:07.000+00:00 properties: items: items: $ref: '#/components/schemas/AgentTokenViewResponse' type: array required: - items type: object AgentTokenRotateRequest: type: object AgentTokenRotateResponse: example: id: id token: token properties: id: type: string token: type: string required: - id - token type: object AgentTokenViewResponse: example: nkey_public: nkey_public created: 2000-01-23T04:56:07.000+00:00 id: id last_accessed_at: 2000-01-23T04:56:07.000+00:00 is_current: true rotated_at: 2000-01-23T04:56:07.000+00:00 properties: created: format: date-time type: string id: type: string is_current: type: boolean last_accessed_at: format: date-time type: string nkey_public: type: string rotated_at: format: date-time type: string required: - created - id - is_current - nkey_public type: object AlertListResponse: example: items: - severity: null closed_at: 2000-01-23T04:56:07.000+00:00 created: 2000-01-23T04:56:07.000+00:00 system_id: system_id metric_value: 0.8008281904610115 message: message alert_rule: severity: null created: 2000-01-23T04:56:07.000+00:00 system_id: system_id duration_in_secs: 0 message: message threshold_expression_metric: threshold_expression_metric threshold_fixed_value: 1.4658129805029452 is_enabled: true account_id: account_id consumer_name: consumer_name rule_type: null stream_name: stream_name metric: metric threshold_operator: threshold_operator id: id threshold_expression_multiplier: 6.027456183070403 sample_values: - value: 1.4658129805029452 timestamp: 6 - value: 1.4658129805029452 timestamp: 6 is_acknowledged: true account_id: account_id consumer_name: consumer_name system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain stream_name: stream_name threshold_value: 5.962133916683182 AcknowledgedByAppUserID: AcknowledgedByAppUserID id: id is_firing: true alert_rule_id: alert_rule_id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true acknowledged_at: 2000-01-23T04:56:07.000+00:00 is_closed: true - severity: null closed_at: 2000-01-23T04:56:07.000+00:00 created: 2000-01-23T04:56:07.000+00:00 system_id: system_id metric_value: 0.8008281904610115 message: message alert_rule: severity: null created: 2000-01-23T04:56:07.000+00:00 system_id: system_id duration_in_secs: 0 message: message threshold_expression_metric: threshold_expression_metric threshold_fixed_value: 1.4658129805029452 is_enabled: true account_id: account_id consumer_name: consumer_name rule_type: null stream_name: stream_name metric: metric threshold_operator: threshold_operator id: id threshold_expression_multiplier: 6.027456183070403 sample_values: - value: 1.4658129805029452 timestamp: 6 - value: 1.4658129805029452 timestamp: 6 is_acknowledged: true account_id: account_id consumer_name: consumer_name system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain stream_name: stream_name threshold_value: 5.962133916683182 AcknowledgedByAppUserID: AcknowledgedByAppUserID id: id is_firing: true alert_rule_id: alert_rule_id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true acknowledged_at: 2000-01-23T04:56:07.000+00:00 is_closed: true properties: items: items: $ref: '#/components/schemas/AlertViewResponse' type: array required: - items type: object AlertRuleAccountCreateRequest: allOf: - $ref: '#/components/schemas/AlertRuleBaseCreateRequest' - required: - rule_type example: consumer_name: consumer_name rule_type: Account stream_name: stream_name properties: consumer_name: type: string rule_type: enum: - Account - Stream - Consumer type: string stream_name: type: string type: object AlertRuleBaseCreateRequest: example: severity: null metric: metric threshold_operator: null duration_in_secs: 0 threshold_expression_multiplier: 6.027456183070403 message: message threshold_expression_metric: null threshold_fixed_value: 1.4658129805029452 properties: duration_in_secs: type: integer message: type: string metric: type: string severity: $ref: '#/components/schemas/AlertRuleSeverity' threshold_expression_metric: $ref: '#/components/schemas/AlertRuleThresholdMetric' threshold_expression_multiplier: type: number threshold_fixed_value: type: number threshold_operator: $ref: '#/components/schemas/AlertRuleOperator' required: - duration_in_secs - message - metric - severity - threshold_operator type: object AlertRuleListResponse: example: items: - severity: null created: 2000-01-23T04:56:07.000+00:00 system_id: system_id duration_in_secs: 0 message: message threshold_expression_metric: threshold_expression_metric threshold_fixed_value: 1.4658129805029452 is_enabled: true account_id: account_id consumer_name: consumer_name rule_type: null stream_name: stream_name metric: metric threshold_operator: threshold_operator id: id threshold_expression_multiplier: 6.027456183070403 - severity: null created: 2000-01-23T04:56:07.000+00:00 system_id: system_id duration_in_secs: 0 message: message threshold_expression_metric: threshold_expression_metric threshold_fixed_value: 1.4658129805029452 is_enabled: true account_id: account_id consumer_name: consumer_name rule_type: null stream_name: stream_name metric: metric threshold_operator: threshold_operator id: id threshold_expression_multiplier: 6.027456183070403 properties: items: items: $ref: '#/components/schemas/AlertRuleViewResponse' type: array required: - items type: object AlertRuleOperator: enum: - Greater Than - Less Than - Greater Than Or Equal - Less Than Or Equal - Equal - Not Equal type: string AlertRuleSeverity: enum: - Info - Warn - Error - Critical type: string AlertRuleSystemCreateRequest: $ref: '#/components/schemas/AlertRuleBaseCreateRequest' AlertRuleThresholdMetric: enum: - account.max_connections - account.max_consumers - account.max_bytes - account.max_exports - account.max_imports - account.max_jwt_expiry - account.max_msg_payload - account.max_streams - account.max_subscriptions - account.JS_max_file - account.JS_max_memory - system.JS_max_memory - system.JS_max_file type: string AlertRuleType: enum: - SystemDefault - System - AccountDefault - Account - Stream - Consumer type: string AlertRuleUpdateRequest: example: is_enabled: true severity: null threshold_operator: null duration_in_secs: 0 threshold_expression_multiplier: 6.027456183070403 message: message threshold_expression_metric: null threshold_fixed_value: 1.4658129805029452 properties: duration_in_secs: type: integer is_enabled: type: boolean message: type: string severity: $ref: '#/components/schemas/AlertRuleSeverity' threshold_expression_metric: $ref: '#/components/schemas/AlertRuleThresholdMetric' threshold_expression_multiplier: type: number threshold_fixed_value: type: number threshold_operator: $ref: '#/components/schemas/AlertRuleOperator' type: object AlertRuleViewResponse: example: severity: null created: 2000-01-23T04:56:07.000+00:00 system_id: system_id duration_in_secs: 0 message: message threshold_expression_metric: threshold_expression_metric threshold_fixed_value: 1.4658129805029452 is_enabled: true account_id: account_id consumer_name: consumer_name rule_type: null stream_name: stream_name metric: metric threshold_operator: threshold_operator id: id threshold_expression_multiplier: 6.027456183070403 properties: account_id: type: string consumer_name: type: string created: format: date-time type: string duration_in_secs: type: integer id: type: string is_enabled: type: boolean message: type: string metric: type: string rule_type: $ref: '#/components/schemas/AlertRuleType' severity: $ref: '#/components/schemas/AlertRuleSeverity' stream_name: type: string system_id: type: string threshold_expression_metric: type: string threshold_expression_multiplier: type: number threshold_fixed_value: type: number threshold_operator: type: string required: - created - duration_in_secs - id - is_enabled - message - metric - rule_type - severity - threshold_operator type: object AlertStatus: enum: - New - Open - Closed type: string AlertViewResponse: example: severity: null closed_at: 2000-01-23T04:56:07.000+00:00 created: 2000-01-23T04:56:07.000+00:00 system_id: system_id metric_value: 0.8008281904610115 message: message alert_rule: severity: null created: 2000-01-23T04:56:07.000+00:00 system_id: system_id duration_in_secs: 0 message: message threshold_expression_metric: threshold_expression_metric threshold_fixed_value: 1.4658129805029452 is_enabled: true account_id: account_id consumer_name: consumer_name rule_type: null stream_name: stream_name metric: metric threshold_operator: threshold_operator id: id threshold_expression_multiplier: 6.027456183070403 sample_values: - value: 1.4658129805029452 timestamp: 6 - value: 1.4658129805029452 timestamp: 6 is_acknowledged: true account_id: account_id consumer_name: consumer_name system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain stream_name: stream_name threshold_value: 5.962133916683182 AcknowledgedByAppUserID: AcknowledgedByAppUserID id: id is_firing: true alert_rule_id: alert_rule_id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true acknowledged_at: 2000-01-23T04:56:07.000+00:00 is_closed: true properties: AcknowledgedByAppUserID: type: string account: $ref: '#/components/schemas/AccountInfo' account_id: type: string acknowledged_at: format: date-time type: string alert_rule: $ref: '#/components/schemas/AlertRuleViewResponse' alert_rule_id: type: string closed_at: format: date-time type: string consumer_name: type: string created: format: date-time type: string id: type: string is_acknowledged: type: boolean is_closed: type: boolean is_firing: type: boolean message: type: string metric_value: format: double type: number sample_values: items: $ref: '#/components/schemas/PromSampleValue' type: array severity: $ref: '#/components/schemas/AlertRuleSeverity' stream_name: type: string system: $ref: '#/components/schemas/SystemInfo' system_id: type: string threshold_value: format: double type: number required: - alert_rule - alert_rule_id - created - id - is_acknowledged - is_closed - is_firing - message - metric_value - sample_values - severity - threshold_value type: object ApexCoordinate: properties: x: format: double type: number "y": format: double type: number required: - x - "y" type: object ApexSeries: properties: data: items: $ref: '#/components/schemas/ApexCoordinate' type: array name: type: string required: - data - name type: object AppPolicy: example: name: name description: description statements: key: resource: - resource - resource service: service effect: - null - null name: name action: - action - action operation_id: operation_id group: null properties: description: type: string group: $ref: '#/components/schemas/AppPolicyGroup' name: type: string statements: additionalProperties: $ref: '#/components/schemas/AppPolicyStatement' type: object required: - group - name - statements type: object AppPolicyGroup: enum: - Core - Cloud - Connectors - Workloads - SchemaRegistry - Insights type: string AppPolicyStatement: example: resource: - resource - resource service: service effect: - null - null name: name action: - action - action operation_id: operation_id properties: action: items: type: string type: array effect: items: $ref: '#/components/schemas/AppRoleEffect' type: array name: type: string operation_id: type: string resource: items: type: string type: array service: type: string required: - action - effect - name - resource type: object AppRole: example: scope: null name: name policies: - policies - policies description: description id: id sort_order: 0.8008281904610115 enabled: true properties: description: type: string enabled: type: boolean id: type: string name: type: string policies: items: type: string type: array scope: $ref: '#/components/schemas/AppRoleScope' sort_order: type: number required: - description - enabled - id - name - policies - scope - sort_order type: object AppRoleEffect: enum: - ALLOW - DENY type: string AppRoleScope: enum: - App - Team - System - Account - NatsUser type: string AppUserAccessTokenCreateRequest: example: expires: 2000-01-23T04:56:07.000+00:00 never_expires: true name: name properties: expires: format: date-time type: string name: type: string never_expires: type: boolean required: - name type: object AppUserAccessTokenCreateResponse: allOf: - $ref: '#/components/schemas/AppUserAccessTokenViewResponse' - required: - token example: token: token properties: token: type: string type: object AppUserAccessTokenListResponse: example: items: - expires: expires created: 2000-01-23T04:56:07.000+00:00 name: name id: id last_active: last_active - expires: expires created: 2000-01-23T04:56:07.000+00:00 name: name id: id last_active: last_active properties: items: items: $ref: '#/components/schemas/AppUserAccessTokenViewResponse' type: array required: - items type: object AppUserAccessTokenUpdateRequest: example: expires: 2000-01-23T04:56:07.000+00:00 never_expires: true name: name properties: expires: format: date-time type: string name: type: string never_expires: type: boolean type: object AppUserAccessTokenViewResponse: example: expires: expires created: 2000-01-23T04:56:07.000+00:00 name: name id: id last_active: last_active properties: created: format: date-time type: string expires: nullable: true type: string id: type: string last_active: nullable: true type: string name: type: string required: - created - id - name type: object AppUserAssignListResponse: example: items: - role_name: role_name nats_user: user_public_key: user_public_key name: name id: id system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null team_app_user: role_name: role_name role_id: role_id pending_invitation: true id: id resource_id: resource_id team: name: name id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true - role_name: role_name nats_user: user_public_key: user_public_key name: name id: id system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null team_app_user: role_name: role_name role_id: role_id pending_invitation: true id: id resource_id: resource_id team: name: name id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true properties: items: items: $ref: '#/components/schemas/AppUserAssignResponse' type: array required: - items type: object AppUserAssignRequest: example: role_id: role_id properties: role_id: type: string required: - role_id type: object AppUserAssignResponse: example: role_name: role_name nats_user: user_public_key: user_public_key name: name id: id system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null team_app_user: role_name: role_name role_id: role_id pending_invitation: true id: id resource_id: resource_id team: name: name id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true properties: account: $ref: '#/components/schemas/AccountInfo' app_user: $ref: '#/components/schemas/AppUserInfo' created: format: date-time type: string nats_user: $ref: '#/components/schemas/NatsUserInfo' resource_id: type: string role_id: type: string role_name: type: string scope: $ref: '#/components/schemas/AppRoleScope' system: $ref: '#/components/schemas/SystemInfo' team: $ref: '#/components/schemas/TeamInfo' team_app_user: $ref: '#/components/schemas/TeamAppUserInfo' required: - app_user - created - resource_id - role_id - role_name - scope - team_app_user type: object AppUserCreateRequest: example: identifier: identifier role_id: role_id name: name properties: identifier: type: string name: type: string role_id: type: string required: - identifier - name - role_id type: object AppUserCreateResponse: allOf: - $ref: '#/components/schemas/AppUserViewResponse' - required: - invitation_link example: invitation_link: invitation_link properties: invitation_link: type: string type: object AppUserInfo: example: identifier: identifier name: name id: id type: null properties: id: type: string identifier: type: string name: type: string type: $ref: '#/components/schemas/AppUserType' required: - id - name - type type: object AppUserInfoListResponse: properties: items: items: $ref: '#/components/schemas/AppUserInfo' type: array required: - items type: object AppUserInvitationRequest: example: associations: - role_id: role_id resource_type: null resource_id: resource_id - role_id: role_id resource_type: null resource_id: resource_id identifier: identifier role_id: role_id name: name properties: associations: items: $ref: '#/components/schemas/TeamAppUserAssociation' type: array identifier: type: string name: type: string role_id: type: string required: - identifier - name - role_id type: object AppUserInvitationResponse: example: app_user: identifier: identifier name: name id: id type: null team_app_user: role_name: role_name role_id: role_id pending_invitation: true id: id properties: app_user: $ref: '#/components/schemas/AppUserInfo' team_app_user: $ref: '#/components/schemas/TeamAppUserInfo' required: - app_user - team_app_user type: object AppUserListResponse: example: items: - role_name: role_name identifier: identifier role_id: role_id created: 2000-01-23T04:56:07.000+00:00 pending_creation: true name: name id: id last_active: last_active type: null - role_name: role_name identifier: identifier role_id: role_id created: 2000-01-23T04:56:07.000+00:00 pending_creation: true name: name id: id last_active: last_active type: null properties: items: items: $ref: '#/components/schemas/AppUserViewResponse' type: array required: - items type: object AppUserType: enum: - Person - AppServiceAccount - TeamServiceAccount type: string AppUserUpdateRequest: example: role_id: role_id name: name reset_password: true properties: name: type: string reset_password: type: boolean role_id: type: string type: object AppUserUpdateResponse: allOf: - $ref: '#/components/schemas/AppUserViewResponse' example: reset_password_link: reset_password_link properties: reset_password_link: type: string type: object AppUserViewResponse: example: role_name: role_name identifier: identifier role_id: role_id created: 2000-01-23T04:56:07.000+00:00 pending_creation: true name: name id: id last_active: last_active type: null properties: created: format: date-time type: string id: type: string identifier: type: string last_active: nullable: true type: string name: type: string pending_creation: type: boolean role_id: type: string role_name: type: string type: $ref: '#/components/schemas/AppUserType' required: - created - id - name - pending_creation - role_id - role_name - type type: object ArtifactListResponse: properties: items: items: $ref: '#/components/schemas/ArtifactSummary' type: array required: - items type: object ArtifactSummary: properties: class: type: string collection: $ref: '#/components/schemas/Collection' deprecated: type: string description: type: string icon: type: string id: type: string name: type: string versions: items: $ref: '#/components/schemas/ArtifactVersion' type: array required: - class - collection - description - icon - id - name - versions type: object ArtifactVersion: properties: changelog: type: string deprecated: type: string tier: type: string version: type: string required: - version type: object AuditCheckResult: example: code: code suite: suite examples: - examples - examples name: name description: description status: pass properties: code: type: string description: type: string examples: items: type: string type: array name: type: string status: enum: - pass - warning - fail - skip - unknown type: string suite: type: string required: - code - description - name - status - suite type: object AuditHealthResponse: example: duration: duration summary: passed_checks: 6 total_checks: 2 skipped_checks: 5 failed_checks: 0 warning_checks: 7 server_count: 1 stream_count: 5 checks: - code: code suite: suite examples: - examples - examples name: name description: description status: pass - code: code suite: suite examples: - examples - examples name: name description: description status: pass system_id: system_id status: healthy timestamp: 2000-01-23T04:56:07.000+00:00 properties: checks: items: $ref: '#/components/schemas/AuditCheckResult' type: array duration: type: string status: enum: - healthy - warning - critical type: string summary: $ref: '#/components/schemas/AuditSummary' system_id: type: string timestamp: format: date-time type: string required: - checks - status - summary - system_id - timestamp type: object AuditJobListResponse: example: items: - duration: duration job_id: job_id system_id: system_id created_at: 2000-01-23T04:56:07.000+00:00 message: message status: queued - duration: duration job_id: job_id system_id: system_id created_at: 2000-01-23T04:56:07.000+00:00 message: message status: queued properties: items: items: $ref: '#/components/schemas/AuditJobResponse' type: array required: - items type: object AuditJobRequest: example: profiles: false server_endpoints: true details: true account_endpoints: true properties: account_endpoints: default: true type: boolean details: default: true type: boolean profiles: default: false type: boolean server_endpoints: default: true type: boolean required: - account_endpoints - details - profiles - server_endpoints type: object AuditJobResponse: example: duration: duration job_id: job_id system_id: system_id created_at: 2000-01-23T04:56:07.000+00:00 message: message status: queued properties: created_at: format: date-time type: string duration: type: string job_id: type: string message: type: string status: enum: - queued - running - completed - failed type: string system_id: type: string required: - created_at - duration - job_id - status - system_id type: object AuditSummary: example: passed_checks: 6 total_checks: 2 skipped_checks: 5 failed_checks: 0 warning_checks: 7 server_count: 1 stream_count: 5 properties: failed_checks: type: integer passed_checks: type: integer server_count: type: integer skipped_checks: type: integer stream_count: type: integer total_checks: type: integer warning_checks: type: integer required: - failed_checks - passed_checks - server_count - skipped_checks - stream_count - total_checks - warning_checks type: object AuthCalloutAddTargetAccountRequest: example: sk_group_id: sk_group_id account_id: account_id control_account_sk_group_id: control_account_sk_group_id properties: account_id: type: string control_account_sk_group_id: type: string sk_group_id: type: string required: - account_id - control_account_sk_group_id - sk_group_id type: object AuthCalloutAddUserRequest: example: nats_user_id: nats_user_id properties: nats_user_id: type: string required: - nats_user_id type: object AuthCalloutAuthenticatorComponentConfig: properties: account: type: string bucket: type: string required: - account - bucket type: object AuthCalloutAuthenticatorConfigViewResponse: example: id: id type: type config: config enabled: true properties: config: type: string enabled: type: boolean id: type: string type: type: string required: - config - enabled - id - type type: object AuthCalloutAuthenticatorUpdateRequest: properties: config: type: string enabled: type: boolean type: type: string required: - config - enabled - type type: object AuthCalloutAuthenticatorViewResponse: example: config_schema: - data: data name: name type: 0 required: true - data: data name: name type: 0 required: true id: id type: type properties: config_schema: items: $ref: '#/components/schemas/PlatformComponentsConfigSchema' type: array id: type: string type: type: string required: - id - type type: object AuthCalloutAuthenticatorsListResponse: example: items: - config_schema: - data: data name: name type: 0 required: true - data: data name: name type: 0 required: true id: id type: type - config_schema: - data: data name: name type: 0 required: true - data: data name: name type: 0 required: true id: id type: type properties: items: items: $ref: '#/components/schemas/AuthCalloutAuthenticatorViewResponse' type: array required: - items type: object AuthCalloutComponentConnectConfig: properties: config_schema: items: $ref: '#/components/schemas/PlatformComponentsConfigSchema' type: array type: type: string required: - config_schema - type type: object AuthCalloutConfig: example: xkey_public: xkey_public control_account_id: control_account_id system_id: system_id id: id properties: control_account_id: type: string id: type: string system_id: type: string xkey_public: type: string required: - control_account_id - id - system_id type: object AuthCalloutConfigListResponse: example: items: - xkey_public: xkey_public control_account_id: control_account_id system_id: system_id id: id - xkey_public: xkey_public control_account_id: control_account_id system_id: system_id id: id properties: items: items: $ref: '#/components/schemas/AuthCalloutConfig' type: array required: - items type: object AuthCalloutEnableRequest: example: control_account: control_account properties: control_account: type: string required: - control_account type: object AuthCalloutTargetAccountListResponse: example: items: - target_account_name: target_account_name control_account_sk_group_id: control_account_sk_group_id target_account_id: target_account_id control_account_sk_group_name: control_account_sk_group_name target_account_sk_group_id: target_account_sk_group_id id: id target_account_sk_group_name: target_account_sk_group_name - target_account_name: target_account_name control_account_sk_group_id: control_account_sk_group_id target_account_id: target_account_id control_account_sk_group_name: control_account_sk_group_name target_account_sk_group_id: target_account_sk_group_id id: id target_account_sk_group_name: target_account_sk_group_name properties: items: items: $ref: '#/components/schemas/AuthCalloutTargetAccountViewResponse' type: array required: - items type: object AuthCalloutTargetAccountViewResponse: example: target_account_name: target_account_name control_account_sk_group_id: control_account_sk_group_id target_account_id: target_account_id control_account_sk_group_name: control_account_sk_group_name target_account_sk_group_id: target_account_sk_group_id id: id target_account_sk_group_name: target_account_sk_group_name properties: control_account_sk_group_id: type: string control_account_sk_group_name: type: string id: type: string target_account_id: type: string target_account_name: type: string target_account_sk_group_id: type: string target_account_sk_group_name: type: string required: - control_account_sk_group_id - control_account_sk_group_name - id - target_account_id - target_account_name - target_account_sk_group_id - target_account_sk_group_name type: object AuthCalloutUserViewResponse: example: name: name id: id nats_user_id: nats_user_id properties: id: type: string name: type: string nats_user_id: type: string required: - id - name - nats_user_id type: object AuthCalloutUsersListResponse: example: items: - name: name id: id nats_user_id: nats_user_id - name: name id: id nats_user_id: nats_user_id properties: items: items: $ref: '#/components/schemas/AuthCalloutUserViewResponse' type: array required: - items type: object AuthCalloutViewResponse: allOf: - $ref: '#/components/schemas/AuthCalloutConfig' example: authenticators: - id: id type: type config: config enabled: true - id: id type: type config: config enabled: true target_accounts: - target_account_name: target_account_name control_account_sk_group_id: control_account_sk_group_id target_account_id: target_account_id control_account_sk_group_name: control_account_sk_group_name target_account_sk_group_id: target_account_sk_group_id id: id target_account_sk_group_name: target_account_sk_group_name - target_account_name: target_account_name control_account_sk_group_id: control_account_sk_group_id target_account_id: target_account_id control_account_sk_group_name: control_account_sk_group_name target_account_sk_group_id: target_account_sk_group_id id: id target_account_sk_group_name: target_account_sk_group_name users: - name: name id: id nats_user_id: nats_user_id - name: name id: id nats_user_id: nats_user_id properties: authenticators: items: $ref: '#/components/schemas/AuthCalloutAuthenticatorConfigViewResponse' type: array target_accounts: items: $ref: '#/components/schemas/AuthCalloutTargetAccountViewResponse' type: array users: items: $ref: '#/components/schemas/AuthCalloutUserViewResponse' type: array type: object AuthzRequest: example: service: service resource_id: "" properties: resource_id: default: "" type: string service: type: string required: - resource_id - service type: object AuthzResponse: example: operations: - operations - operations service: service resource_id: resource_id properties: operations: items: type: string type: array resource_id: type: string service: type: string required: - operations - resource_id - service type: object AuthzViewRequest: items: $ref: '#/components/schemas/AuthzRequest' type: array AuthzViewResponse: items: $ref: '#/components/schemas/AuthzResponse' type: array AvailableChartVersion: example: app_version: app_version repo: repo type: type chart: chart version: version properties: app_version: type: string chart: type: string repo: type: string type: type: string version: type: string required: - app_version - chart - repo - type - version type: object AvailableChartVersions: items: $ref: '#/components/schemas/AvailableChartVersion' type: array AvailableComponentVersionsRequest: example: deployment_type: deployment_type major: 2147483647 minor: 2147483647 properties: deployment_type: type: string major: default: -1 maximum: 9223372036854775807 minimum: -1 type: integer minor: default: -1 maximum: 9223372036854775807 minimum: -1 type: integer required: - major - minor type: object AvailableComponentVersionsResponse: additionalProperties: $ref: '#/components/schemas/AvailableChartVersions' type: object BulkShareRequest: example: target_accounts: - local_subject: local_subject id: id auto_accept: false - local_subject: local_subject id: id auto_accept: false id: id type: null properties: id: type: string target_accounts: items: $ref: '#/components/schemas/BulkShareTarget' type: array type: $ref: '#/components/schemas/BulkShareType' required: - id - target_accounts - type type: object BulkShareTarget: example: local_subject: local_subject id: id auto_accept: false properties: auto_accept: default: false type: boolean id: type: string local_subject: type: string required: - auto_accept - id - local_subject type: object BulkShareType: enum: - stream - subject type: string CatalogPlatformComponentConfig: properties: account: default: "" type: string catalog_id: type: string required: - account - catalog_id type: object ChecksSummary: example: code: code examples: - examples - examples name: name description: description status: pass properties: code: type: string description: type: string examples: items: type: string type: array name: type: string status: enum: - pass - info - warning - fail - skip - unknown type: string required: - code - description - name - status type: object ClaimType: description: ClaimType is used to indicate the type of JWT being stored in a Claim type: string ClaimsData: description: ClaimsData is the base struct for all claims properties: aud: type: string exp: format: int64 type: integer iat: format: int64 type: integer iss: type: string jti: type: string name: type: string nbf: format: int64 type: integer sub: type: string type: object ClusterChartType: enum: - NumConnections - NumSubscriptions - CPUUsage - MemoryUsage - NumSlowConsumer - BytesSent - BytesReceived - NumMessagesSent - NumMessagesReceived - GatewayBytesSent - GatewayBytesReceived - GatewayNumMessagesSent - GatewayNumMessagesReceived - RouteBytesSent - RouteBytesReceived - RouteNumMessagesSent - RouteNumMessagesReceived - RouteBytesPending type: string ClusterInfo: description: |- ClusterInfo shows information about the underlying set of servers that make up the stream or consumer. example: leader: leader system_account: true replicas: - null - null raft_group: raft_group name: name traffic_account: traffic_account leader_since: leader_since properties: leader: type: string leader_since: nullable: true type: string name: type: string raft_group: type: string replicas: items: $ref: '#/components/schemas/ClusterInfo_replicas_inner' type: array system_account: type: boolean traffic_account: type: string type: object ClusterOverview: example: jetstream_enabled: true gateways: - inbound: 0 outbound: 6 name: name - inbound: 0 outbound: 6 name: name incoming_gateways: 1 total_connections: 2 total_cpu_percent: 7.061401241503109 nodes: - nodes - nodes total_memory_bytes: 9 name: name outgoing_gateways: 5 node_count: 5 total_routes: 3 properties: gateways: items: $ref: '#/components/schemas/GatewayConnection' type: array incoming_gateways: type: integer jetstream_enabled: type: boolean name: type: string node_count: type: integer nodes: items: type: string type: array outgoing_gateways: type: integer total_connections: type: integer total_cpu_percent: type: number total_memory_bytes: type: integer total_routes: type: integer required: - incoming_gateways - jetstream_enabled - name - node_count - nodes - outgoing_gateways - total_connections - total_cpu_percent - total_memory_bytes - total_routes type: object ClusterOverviewResponse: description: Cluster Overview Response example: summary: total_connections: 7 total_clusters: 6 total_nodes: 4 total_routes: 5 total_gateways: 1 checks: - code: code examples: - examples - examples name: name description: description status: pass - code: code examples: - examples - examples name: name description: description status: pass system_id: system_id raft_summary: empty_wal_groups: 2 healthy_groups: 4 leaderless_groups: 7 out_of_sync_groups: 1 total_groups: 1 wal_error_groups: 1 clusters: - jetstream_enabled: true gateways: - inbound: 0 outbound: 6 name: name - inbound: 0 outbound: 6 name: name incoming_gateways: 1 total_connections: 2 total_cpu_percent: 7.061401241503109 nodes: - nodes - nodes total_memory_bytes: 9 name: name outgoing_gateways: 5 node_count: 5 total_routes: 3 - jetstream_enabled: true gateways: - inbound: 0 outbound: 6 name: name - inbound: 0 outbound: 6 name: name incoming_gateways: 1 total_connections: 2 total_cpu_percent: 7.061401241503109 nodes: - nodes - nodes total_memory_bytes: 9 name: name outgoing_gateways: 5 node_count: 5 total_routes: 3 timestamp: timestamp properties: checks: items: $ref: '#/components/schemas/ChecksSummary' type: array clusters: items: $ref: '#/components/schemas/ClusterOverview' type: array raft_summary: $ref: '#/components/schemas/RaftSummary' summary: $ref: '#/components/schemas/ClusterOverviewSummary' system_id: type: string timestamp: type: string required: - clusters - summary - system_id - timestamp type: object ClusterOverviewSummary: example: total_connections: 7 total_clusters: 6 total_nodes: 4 total_routes: 5 total_gateways: 1 properties: total_clusters: type: integer total_connections: type: integer total_gateways: type: integer total_nodes: type: integer total_routes: type: integer required: - total_clusters - total_connections - total_gateways - total_nodes - total_routes type: object Collection: properties: id: type: string name: type: string version: type: string required: - id - name - version type: object Compression: enum: - none - s2 type: string ConnInfo: description: ConnInfo has detailed information on a per connection basis. properties: account: type: string authorized_user: type: string cid: maximum: 18446744073709551615 minimum: 0 type: integer idle: type: string in_bytes: format: int64 type: integer in_msgs: format: int64 type: integer ip: type: string issuer_key: type: string jwt: type: string kind: type: string lang: type: string last_activity: format: date-time type: string mqtt_client: type: string name: type: string name_tag: type: string out_bytes: format: int64 type: integer out_msgs: format: int64 type: integer pending_bytes: type: integer port: type: integer reason: type: string rtt: type: string start: format: date-time type: string stop: nullable: true type: string subscriptions: maximum: 4294967295 minimum: 0 type: integer subscriptions_list: items: type: string type: array subscriptions_list_detail: items: $ref: '#/components/schemas/SubDetail' type: array tags: items: type: string type: array tls_cipher_suite: type: string tls_peer_certs: items: $ref: '#/components/schemas/ConnInfo_tls_peer_certs_inner' type: array tls_version: type: string type: type: string uptime: type: string version: type: string required: - cid - idle - in_bytes - in_msgs - ip - last_activity - out_bytes - out_msgs - pending_bytes - port - start - subscriptions - uptime type: object ConnectorCreateRequest: allOf: - $ref: '#/components/schemas/WorkloadStartRequest' - required: - collection_id - component_id - component_version - template properties: collection_id: type: string component_id: type: string component_version: type: string template: type: object type: object ConnectorsPlatformComponentConfig: properties: account: type: string required: - account type: object Connz: description: Connz represents detailed information on current client connections. example: total: 5 offset: 1 now: 2000-01-23T04:56:07.000+00:00 limit: 0 num_connections: 6 server_id: server_id connections: - null - null properties: connections: items: $ref: '#/components/schemas/Connz_connections_inner' type: array limit: type: integer now: format: date-time type: string num_connections: type: integer offset: type: integer server_id: type: string total: type: integer required: - connections - limit - now - num_connections - offset - server_id - total type: object ConsumerConfig: description: |- ConsumerConfig is the configuration for a JetStream consumes NATS Schema Type io.nats.jetstream.api.v1.consumer_configuration properties: ack_policy: $ref: '#/components/schemas/AckPolicy' ack_wait: format: int64 type: integer backoff: items: format: int64 type: integer type: array deliver_group: type: string deliver_policy: $ref: '#/components/schemas/DeliverPolicy' deliver_subject: type: string description: type: string direct: description: Don't add to general clients. type: boolean durable_name: type: string filter_subject: type: string filter_subjects: items: type: string type: array flow_control: type: boolean headers_only: type: boolean idle_heartbeat: format: int64 type: integer inactive_threshold: format: int64 type: integer max_ack_pending: type: integer max_batch: type: integer max_bytes: type: integer max_deliver: type: integer max_expires: format: int64 type: integer max_waiting: type: integer mem_storage: type: boolean metadata: additionalProperties: type: string description: Metadata is additional metadata for the Consumer. type: object name: type: string num_replicas: type: integer opt_start_seq: maximum: 18446744073709551615 minimum: 0 type: integer opt_start_time: nullable: true type: string pause_until: description: PauseUntil suspends the consumer until the deadline. format: date-time type: string priority_groups: items: type: string type: array priority_policy: $ref: '#/components/schemas/PriorityPolicy' priority_timeout: format: int64 type: integer rate_limit_bps: maximum: 18446744073709551615 minimum: 0 type: integer replay_policy: $ref: '#/components/schemas/ReplayPolicy' sample_freq: type: string required: - ack_policy - deliver_policy - num_replicas - replay_policy type: object ConsumerInfo: description: ConsumerInfo reports the current state of a consumer properties: ack_floor: $ref: '#/components/schemas/SequenceInfo' cluster: $ref: '#/components/schemas/ConsumerInfo_cluster' config: $ref: '#/components/schemas/ConsumerConfig' created: format: date-time type: string delivered: $ref: '#/components/schemas/SequenceInfo' name: type: string num_ack_pending: type: integer num_pending: maximum: 18446744073709551615 minimum: 0 type: integer num_redelivered: type: integer num_waiting: type: integer pause_remaining: format: int64 type: integer paused: type: boolean priority_groups: items: $ref: '#/components/schemas/PriorityGroupState' type: array push_bound: type: boolean stream_name: type: string ts: format: date-time type: string required: - ack_floor - config - created - delivered - name - num_ack_pending - num_pending - num_redelivered - num_waiting - stream_name - ts type: object DataLimits: example: total_sent: 2 gateway_sent: 5 route_received: 7 route_sent: 9 client_received: 0 client_sent: 6 leaf_sent: 2 leaf_received: 5 gateway_received: 1 total_received: 3 properties: client_received: format: int64 type: integer client_sent: format: int64 type: integer gateway_received: format: int64 type: integer gateway_sent: format: int64 type: integer leaf_received: format: int64 type: integer leaf_sent: format: int64 type: integer route_received: format: int64 type: integer route_sent: format: int64 type: integer total_received: format: int64 type: integer total_sent: format: int64 type: integer required: - client_received - client_sent - gateway_received - gateway_sent - leaf_received - leaf_sent - route_received - route_sent - total_received - total_sent type: object DataStats: description: DataStats reports how may msg and bytes. Applicable for both sent and received. example: msgs: 9 bytes: 7 properties: bytes: format: int64 type: integer msgs: format: int64 type: integer required: - bytes - msgs type: object DeliverPolicy: enum: - all - last - new - by_start_sequence - by_start_time - last_per_subject type: string DiscardPolicy: description: enums have been changed to match UnmarshalJSON in https://github.com/nats-io/jsm.go/blob/main/api/streams.go enum: - old - new type: string EntitlementsView: example: http_gateway: 5 schema_registry: 7 fleet: 1 connectors: 6 insights: 5 catalog: 0 workloads: 9 protect: 2 properties: catalog: type: integer connectors: type: integer fleet: type: integer http_gateway: type: integer insights: type: integer protect: type: integer schema_registry: type: integer workloads: type: integer required: - catalog - connectors - fleet - http_gateway - insights - protect - schema_registry - workloads type: object Export: allOf: - $ref: '#/components/schemas/Info' description: Export represents a single export example: revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 properties: account_token_position: minimum: 0 type: integer advertise: type: boolean name: type: string response_threshold: format: int64 type: integer response_type: $ref: '#/components/schemas/ResponseType' revocations: additionalProperties: format: int64 type: integer description: RevocationList is used to store a mapping of public keys to unix timestamps type: object service_latency: $ref: '#/components/schemas/ServiceLatency' subject: type: string token_req: type: boolean type: $ref: '#/components/schemas/ExportType' type: object ExportPatch: example: revocations: "{}" account_token_position: 0 subject: subject name: name description: description response_type: null token_req: true type: null service_latency: null advertise: true info_url: info_url response_threshold: 2147483647 properties: account_token_position: minimum: 0 nullable: true type: integer advertise: type: boolean description: nullable: true type: string info_url: nullable: true type: string name: type: string response_threshold: maximum: 9223372036854775807 minimum: -9223372036854775808 nullable: true type: integer response_type: $ref: '#/components/schemas/ResponseType' revocations: allOf: - $ref: '#/components/schemas/RevocationListPatch' nullable: true type: object service_latency: $ref: '#/components/schemas/ExportPatch_service_latency' subject: type: string token_req: type: boolean type: $ref: '#/components/schemas/ExportType' type: object ExportType: description: ExportType defines the type of import/export. enum: - stream - service type: string Exports: description: Exports is a slice of exports items: $ref: '#/components/schemas/Export' type: array ExternalAuthorization: example: allowed_accounts: - allowed_accounts - allowed_accounts auth_users: - auth_users - auth_users xkey: xkey properties: allowed_accounts: items: type: string type: array auth_users: items: type: string nullable: true type: array xkey: type: string required: - auth_users type: object ExternalAuthorizationPatch: properties: allowed_accounts: items: type: string nullable: true type: array auth_users: items: type: string nullable: true type: array xkey: type: string type: object ExternalStream: description: ExternalStream allows you to qualify access to a stream source in another account. properties: api: type: string deliver: type: string required: - api - deliver type: object GatewayConnection: example: inbound: 0 outbound: 6 name: name properties: inbound: type: integer name: type: string outbound: type: integer required: - inbound - name - outbound type: object GatewayStat: description: GatewayStat holds gateway statistics. properties: gwid: maximum: 18446744073709551615 minimum: 0 type: integer inbound_connections: type: integer name: type: string received: $ref: '#/components/schemas/DataStats' sent: $ref: '#/components/schemas/DataStats' required: - gwid - inbound_connections - name - received - sent type: object GenericFields: properties: tags: items: type: string type: array type: description: ClaimType is used to indicate the type of JWT being stored in a Claim type: string version: type: integer type: object GetResponse: properties: schema: $ref: '#/components/schemas/GetResponse_schema' type: object GroupMapping: example: team_assignments: - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name app_role: app_role properties: app_role: type: string team_assignments: items: $ref: '#/components/schemas/TeamAssignment' type: array type: object HealthCheckResponse: description: Health Check Response - equivalent to 'nats server report health' example: summary: critical: 6 total_errors: 5 healthy: 5 total_servers: 2 degraded: 1 checks: - code: code examples: - examples - examples name: name description: description status: pass - code: code examples: - examples - examples name: name description: description status: pass servers: - cluster: cluster server: server status_code: 0 domain: domain errors: - error: error type: type - error: error type: type status: ok - cluster: cluster server: server status_code: 0 domain: domain errors: - error: error type: type - error: error type: type status: ok system_id: system_id status: healthy timestamp: timestamp properties: checks: items: $ref: '#/components/schemas/ChecksSummary' type: array servers: items: $ref: '#/components/schemas/ServerHealthInfo' type: array status: enum: - healthy - degraded - critical type: string summary: $ref: '#/components/schemas/HealthSummary' system_id: type: string timestamp: type: string required: - servers - status - summary - system_id - timestamp type: object HealthError: example: error: error type: type properties: error: type: string type: type: string required: - error - type type: object HealthSummary: example: critical: 6 total_errors: 5 healthy: 5 total_servers: 2 degraded: 1 properties: critical: type: integer degraded: type: integer healthy: type: integer total_errors: type: integer total_servers: type: integer required: - critical - degraded - healthy - total_errors - total_servers type: object HttpGatewayPlatformComponentConfig: properties: account: type: string token_bucket: type: string url: type: string required: - account - token_bucket - url type: object Import: description: Import describes a mapping from another account into this one example: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token properties: account: type: string local_subject: description: |- Local subject used to subscribe (for streams) and publish (for services) to. This value only needs setting if you want to change the value of Subject. If the value of Subject ends in > then LocalSubject needs to end in > as well. LocalSubject can contain $ wildcard references where number references the nth wildcard in Subject. The sum of wildcard reference and * tokens needs to match the number of * token in Subject. type: string name: type: string share: type: boolean subject: description: |- Subject field in an import is always from the perspective of the initial publisher - in the case of a stream it is the account owning the stream (the exporter), and in the case of a service it is the account making the request (the importer). type: string to: description: |- Deprecated: use LocalSubject instead To field in an import is always from the perspective of the subscriber in the case of a stream it is the client of the stream (the importer), from the perspective of a service, it is the subscription waiting for requests (the exporter). If the field is empty, it will default to the value in the Subject field. type: string token: type: string type: $ref: '#/components/schemas/ExportType' type: object ImportPatch: example: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token properties: account: type: string local_subject: nullable: true type: string name: type: string share: type: boolean subject: type: string to: nullable: true type: string token: nullable: true type: string type: $ref: '#/components/schemas/ExportType' type: object Imports: description: Imports is a list of import structs items: $ref: '#/components/schemas/Import' type: array Info: properties: description: type: string info_url: type: string type: object InsightsAccountStats: properties: account: type: string bytes_recv: format: int64 type: integer bytes_sent: format: int64 type: integer conns: format: int64 type: integer epoch: format: date-time type: string gateway_bytes_recv: format: int64 type: integer gateway_bytes_sent: format: int64 type: integer gateway_msgs_recv: format: int64 type: integer gateway_msgs_sent: format: int64 type: integer leaf_bytes_recv: format: int64 type: integer leaf_bytes_sent: format: int64 type: integer leaf_msgs_recv: format: int64 type: integer leaf_msgs_sent: format: int64 type: integer leafnodes: format: int64 type: integer msgs_recv: format: int64 type: integer msgs_sent: format: int64 type: integer pk: format: int64 type: integer route_bytes_recv: format: int64 type: integer route_bytes_sent: format: int64 type: integer route_msgs_recv: format: int64 type: integer route_msgs_sent: format: int64 type: integer server_pk: format: int64 type: integer slow_consumers: format: int64 type: integer subs: format: int64 type: integer required: - account - bytes_recv - bytes_sent - conns - epoch - gateway_bytes_recv - gateway_bytes_sent - gateway_msgs_recv - gateway_msgs_sent - leaf_bytes_recv - leaf_bytes_sent - leaf_msgs_recv - leaf_msgs_sent - leafnodes - msgs_recv - msgs_sent - pk - route_bytes_recv - route_bytes_sent - route_msgs_recv - route_msgs_sent - server_pk - slow_consumers - subs type: object InsightsConn: properties: account: type: string bearer: type: boolean bytes_recv: format: int64 type: integer bytes_sent: format: int64 type: integer epoch: format: date-time type: string id: format: int64 type: integer ip: type: string is_connect_node: type: boolean is_nex_agent: type: boolean is_nex_node: type: boolean is_service: type: boolean issuer_account: type: string kind: type: string lang: type: string last_activity: format: date-time type: string lat: maximum: 179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 minimum: -179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 nullable: true type: number lng: maximum: 179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 minimum: -179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 nullable: true type: number msgs_recv: format: int64 type: integer msgs_sent: format: int64 type: integer name: type: string num_subs: format: int64 type: integer pk: format: int64 type: integer port: format: int64 type: integer reason: type: string rtt: format: double type: number server_pk: format: int64 type: integer start_time: format: date-time type: string stop_time: format: date-time type: string type: type: string user: type: string user_jwt: type: string version: type: string required: - account - bearer - bytes_recv - bytes_sent - epoch - id - ip - is_connect_node - is_nex_agent - is_nex_node - is_service - issuer_account - kind - lang - last_activity - lat - lng - msgs_recv - msgs_sent - name - num_subs - pk - port - reason - rtt - server_pk - start_time - stop_time - type - user - user_jwt - version type: object InsightsConsumer: properties: ack_floor_consumer_seq: format: int64 type: integer ack_floor_stream_seq: format: int64 type: integer ack_policy: type: string created_at: format: date-time type: string deliver_group: type: string deliver_policy: type: string deliver_subject: type: string delivered_consumer_seq: format: int64 type: integer delivered_stream_seq: format: int64 type: integer epoch: format: date-time type: string filter_subjects: items: type: string type: array flow_control: type: boolean headers_only: type: boolean inactive_threshold: format: int64 type: integer max_ack_pending: format: int64 type: integer max_batch: format: int64 type: integer max_bytes: format: int64 type: integer max_deliver: format: int64 type: integer max_expires: format: int64 type: integer max_waiting: format: int64 type: integer name: type: string num_ack_pending: format: int64 type: integer num_pending: format: int64 type: integer num_redelivered: format: int64 type: integer num_replicas: format: int64 type: integer num_waiting: format: int64 type: integer pk: format: int64 type: integer replay_policy: type: string server_pk: format: int64 type: integer storage_type: type: string stream_pk: format: int64 type: integer required: - ack_floor_consumer_seq - ack_floor_stream_seq - ack_policy - created_at - deliver_group - deliver_policy - deliver_subject - delivered_consumer_seq - delivered_stream_seq - epoch - filter_subjects - flow_control - headers_only - inactive_threshold - max_ack_pending - max_batch - max_bytes - max_deliver - max_expires - max_waiting - name - num_ack_pending - num_pending - num_redelivered - num_replicas - num_waiting - pk - replay_policy - server_pk - storage_type - stream_pk type: object InsightsLeaf: properties: account: type: string compression: type: string epoch: format: date-time type: string in_bytes: format: int64 type: integer in_msgs: format: int64 type: integer ip: type: string is_spoke: type: boolean lat: maximum: 179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 minimum: -179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 nullable: true type: number lng: maximum: 179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 minimum: -179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 nullable: true type: number name: type: string out_bytes: format: int64 type: integer out_msgs: format: int64 type: integer pk: format: int64 type: integer port: format: int64 type: integer rtt: format: int64 type: integer server_pk: format: int64 type: integer subs: items: type: string type: array required: - account - compression - epoch - in_bytes - in_msgs - ip - is_spoke - lat - lng - name - out_bytes - out_msgs - pk - port - rtt - server_pk - subs type: object InsightsPlatformComponentConfig: properties: account: type: string required: - account type: object InsightsServer: properties: auth_required: type: boolean cluster: type: string cores: format: int64 type: integer cpu: format: double type: number epoch: format: date-time type: string host: type: string id: type: string ip: type: string lat: maximum: 179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 minimum: -179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 nullable: true type: number lng: maximum: 179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 minimum: -179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 nullable: true type: number memory: format: int64 type: integer name: type: string pk: format: int64 type: integer port: format: int64 type: integer slow_consumers: format: int64 type: integer start_time: format: date-time type: string tags: items: type: string type: array version: type: string required: - auth_required - cluster - cores - cpu - epoch - host - id - ip - lat - lng - memory - name - pk - port - slow_consumers - start_time - tags - version type: object InsightsStream: properties: account: type: string bytes: format: int64 type: integer cluster: type: string created_at: format: date-time type: string deduplication_window: format: int64 type: integer discard_policy: type: string epoch: format: date-time type: string first_seq: format: int64 type: integer first_ts: format: date-time type: string has_republish: type: boolean has_subject_transform: type: boolean hbytes: type: string hmsgs: type: string is_kv: type: boolean is_mirror: type: boolean is_object: type: boolean last_seq: format: int64 type: integer last_ts: format: date-time type: string max_age: format: int64 type: integer max_bytes: format: int64 type: integer max_consumers: format: int64 type: integer max_msgs: format: int64 type: integer max_msgs_per_subject: format: int64 type: integer mirror_api_prefix: type: string mirror_name: type: string msgs: format: int64 type: integer name: type: string num_replicas: format: int64 type: integer num_sources: format: int64 type: integer num_subjects: format: int64 type: integer pk: format: int64 type: integer placement_cluster: type: string placement_tags: items: type: string type: array retention_policy: type: string server_pk: format: int64 type: integer storage_type: type: string store_compression: type: string subjects: items: type: string type: array required: - account - bytes - cluster - created_at - deduplication_window - discard_policy - epoch - first_seq - first_ts - has_republish - has_subject_transform - hbytes - hmsgs - is_kv - is_mirror - is_object - last_seq - last_ts - max_age - max_bytes - max_consumers - max_msgs - max_msgs_per_subject - mirror_api_prefix - mirror_name - msgs - name - num_replicas - num_sources - num_subjects - pk - placement_cluster - placement_tags - retention_policy - server_pk - storage_type - store_compression - subjects type: object InsightsSub: properties: conn_pk: format: int64 type: integer epoch: format: date-time type: string id: format: int64 type: integer max_msgs: format: int64 type: integer msgs_recv: format: int64 type: integer pk: format: int64 type: integer queue: type: string subject: type: string required: - conn_pk - epoch - id - max_msgs - msgs_recv - pk - queue - subject type: object InvitationDecisionRequest: example: accept: true properties: accept: type: boolean required: - accept type: object InvitationListResponse: example: items: - name: name id: id - name: name id: id properties: items: items: $ref: '#/components/schemas/TeamInfo' type: array required: - items type: object JSAcctStats: $ref: '#/components/schemas/JetStreamAccountStats' JSApiError: description: JSApiError retains the existing schema name; the upstream Go type is now ApiError. properties: code: type: integer description: type: string err_code: maximum: 65535 minimum: 0 type: integer required: - code type: object JSCommonConsumerConfigRequest: properties: ack_policy: $ref: '#/components/schemas/AckPolicy' ack_wait: format: int64 type: integer backoff: items: format: int64 type: integer type: array deliver_policy: $ref: '#/components/schemas/DeliverPolicy' description: type: string direct: type: boolean durable_name: type: string filter_subjects: items: type: string type: array inactive_threshold: format: int64 type: integer max_ack_pending: type: integer max_deliver: type: integer mem_storage: type: boolean metadata: additionalProperties: type: string type: object name: type: string num_replicas: type: integer opt_start_seq: maximum: 18446744073709551615 minimum: 0 type: integer opt_start_time: format: date-time type: string pause_until: format: date-time type: string replay_policy: $ref: '#/components/schemas/ReplayPolicy' sample_freq: type: string required: - ack_policy - deliver_policy - num_replicas - replay_policy type: object JSCommonStreamConfig: properties: allow_atomic: type: boolean allow_batched: type: boolean allow_direct: type: boolean allow_msg_counter: type: boolean allow_msg_schedules: type: boolean allow_msg_ttl: type: boolean allow_rollup_hdrs: type: boolean compression: $ref: '#/components/schemas/Compression' consumer_limits: $ref: '#/components/schemas/JSStreamConsumerLimits' deny_delete: type: boolean deny_purge: type: boolean description: type: string discard: $ref: '#/components/schemas/DiscardPolicy' discard_new_per_subject: type: boolean duplicate_window: format: int64 type: integer first_seq: maximum: 18446744073709551615 minimum: 0 type: integer max_age: format: int64 type: integer max_bytes: format: int64 type: integer max_consumers: type: integer max_msg_size: format: int32 type: integer max_msgs: format: int64 type: integer max_msgs_per_subject: format: int64 type: integer metadata: additionalProperties: type: string type: object name: type: string no_ack: type: boolean num_replicas: type: integer persist_mode: $ref: '#/components/schemas/JSPersistMode' placement: $ref: '#/components/schemas/Placement' republish: $ref: '#/components/schemas/RePublish' retention: $ref: '#/components/schemas/RetentionPolicy' sealed: type: boolean sources: items: $ref: '#/components/schemas/StreamSource' type: array storage: $ref: '#/components/schemas/StorageType' subject_delete_marker_ttl: format: int64 type: integer subject_transform: $ref: '#/components/schemas/SubjectTransformConfig' template_owner: type: string required: - allow_direct - allow_rollup_hdrs - deny_delete - deny_purge - discard - max_age - max_bytes - max_consumers - max_msgs - max_msgs_per_subject - name - num_replicas - retention - sealed - storage type: object JSCommonStreamInfo: properties: alternates: items: $ref: '#/components/schemas/StreamAlternate' type: array cluster: $ref: '#/components/schemas/ClusterInfo' created: format: date-time type: string domain: type: string name: type: string sources: items: $ref: '#/components/schemas/StreamSourceInfo' type: array state: $ref: '#/components/schemas/StreamState' ts: format: date-time type: string required: - created - name - state - ts type: object JSConsumerInfoListResponse: example: items: - consumer_type: null id: id - consumer_type: null id: id properties: items: items: $ref: '#/components/schemas/JSConsumerInfoResponse' type: array required: - items type: object JSConsumerInfoResponse: allOf: - $ref: '#/components/schemas/ConsumerInfo' - required: - consumer_type - id example: consumer_type: null id: id properties: consumer_type: $ref: '#/components/schemas/JSConsumerType' id: type: string type: object JSConsumerType: enum: - push - pull type: string JSKVBucketConfig: example: metadata: key: metadata mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest sources: - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest max_value_size: 2 description: description history: 153 max_bytes: 5 storage: null bucket: bucket max_age: 5 republish: src: src headers_only: true dest: dest num_replicas: 9 limit_marker_ttl: 1 placement: cluster: cluster tags: - tags - tags compression: false properties: bucket: type: string compression: default: false type: boolean description: type: string history: default: 1 maximum: 255 minimum: 0 type: integer limit_marker_ttl: format: int64 type: integer max_age: format: int64 type: integer max_bytes: format: int64 type: integer max_value_size: format: int32 type: integer metadata: additionalProperties: type: string type: object mirror: $ref: '#/components/schemas/StreamSource' num_replicas: default: 1 type: integer placement: $ref: '#/components/schemas/Placement' republish: $ref: '#/components/schemas/RePublish' sources: items: $ref: '#/components/schemas/StreamSource' type: array storage: $ref: '#/components/schemas/StorageType' required: - bucket - storage type: object JSKVBucketListResponse: example: items: - num_values: 2147483647 stream_name: stream_name bytes: 2147483647 id: id config: metadata: key: metadata mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest sources: - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest max_value_size: 2 description: description history: 153 max_bytes: 5 storage: null bucket: bucket max_age: 5 republish: src: src headers_only: true dest: dest num_replicas: 9 limit_marker_ttl: 1 placement: cluster: cluster tags: - tags - tags compression: false - num_values: 2147483647 stream_name: stream_name bytes: 2147483647 id: id config: metadata: key: metadata mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest sources: - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest max_value_size: 2 description: description history: 153 max_bytes: 5 storage: null bucket: bucket max_age: 5 republish: src: src headers_only: true dest: dest num_replicas: 9 limit_marker_ttl: 1 placement: cluster: cluster tags: - tags - tags compression: false properties: items: items: $ref: '#/components/schemas/JSKVBucketViewResponse' type: array required: - items type: object JSKVBucketUpdateRequest: example: config: metadata: key: metadata mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest sources: - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest max_value_size: 5 description: description history: 20 max_bytes: 5 max_age: 1 republish: src: src headers_only: true dest: dest num_replicas: 2 limit_marker_ttl: 6 placement: cluster: cluster tags: - tags - tags compression: true properties: config: $ref: '#/components/schemas/UpdatableKVBucketConfig' required: - config type: object JSKVBucketViewResponse: example: num_values: 2147483647 stream_name: stream_name bytes: 2147483647 id: id config: metadata: key: metadata mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest sources: - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest max_value_size: 2 description: description history: 153 max_bytes: 5 storage: null bucket: bucket max_age: 5 republish: src: src headers_only: true dest: dest num_replicas: 9 limit_marker_ttl: 1 placement: cluster: cluster tags: - tags - tags compression: false properties: bytes: maximum: 18446744073709551615 minimum: 0 type: integer config: $ref: '#/components/schemas/JSKVBucketConfig' id: type: string num_values: maximum: 18446744073709551615 minimum: 0 type: integer stream_name: type: string required: - bytes - config - id - num_values - stream_name type: object JSMirrorConfigRequest: allOf: - $ref: '#/components/schemas/JSCommonStreamConfig' - required: - mirror - mirror_direct example: mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest mirror_direct: true properties: mirror: $ref: '#/components/schemas/StreamSource' mirror_direct: type: boolean type: object JSMirrorConfigResponse: $ref: '#/components/schemas/JSMirrorConfigRequest' JSMirrorInfoListResponse: example: items: - shared: true mirror: external: null lag: 2147483647 name: name active: 0 error: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest id: id config: mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest mirror_direct: true - shared: true mirror: external: null lag: 2147483647 name: name active: 0 error: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest id: id config: mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest mirror_direct: true properties: items: items: $ref: '#/components/schemas/JSMirrorInfoResponse' type: array required: - items type: object JSMirrorInfoResponse: allOf: - $ref: '#/components/schemas/JSCommonStreamInfo' - required: - config - id - shared example: shared: true mirror: external: null lag: 2147483647 name: name active: 0 error: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest id: id config: mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest mirror_direct: true properties: config: $ref: '#/components/schemas/JSMirrorConfigRequest' id: type: string mirror: $ref: '#/components/schemas/StreamSourceInfo' shared: type: boolean type: object JSObjectBucketConfig: allOf: - $ref: '#/components/schemas/ObjectStoreConfig' example: storage: null properties: storage: $ref: '#/components/schemas/StorageType' type: object JSObjectBucketListResponse: example: items: - stream_name: stream_name bytes: 2147483647 id: id config: storage: null - stream_name: stream_name bytes: 2147483647 id: id config: storage: null properties: items: items: $ref: '#/components/schemas/JSObjectBucketViewResponse' type: array required: - items type: object JSObjectBucketUpdateRequest: example: sealed: true really_sealed: true config: max_age: 0 metadata: key: metadata num_replicas: 1 description: description max_bytes: 6 placement: cluster: cluster tags: - tags - tags compression: true properties: config: $ref: '#/components/schemas/UpdatableObjectBucketConfig' really_sealed: type: boolean sealed: type: boolean required: - config type: object JSObjectBucketViewResponse: example: stream_name: stream_name bytes: 2147483647 id: id config: storage: null properties: bytes: maximum: 18446744073709551615 minimum: 0 type: integer config: $ref: '#/components/schemas/JSObjectBucketConfig' id: type: string stream_name: type: string required: - bytes - config - id - stream_name type: object JSPersistMode: enum: - default - async type: string JSPlacementOptionsResponse: example: num_replicas: - 0 - 0 clusters: - clusters - clusters tags: - tags - tags properties: clusters: items: type: string type: array num_replicas: items: type: integer type: array tags: items: type: string type: array required: - clusters - num_replicas - tags type: object JSPullConsumerConfigRequest: allOf: - $ref: '#/components/schemas/JSCommonConsumerConfigRequest' example: max_waiting: 2 priority_timeout: 7 priority_groups: - priority_groups - priority_groups priority_policy: null max_expires: 5 max_bytes: 5 max_batch: 1 properties: max_batch: type: integer max_bytes: type: integer max_expires: format: int64 type: integer max_waiting: description: Pull based options. type: integer priority_groups: items: type: string type: array priority_policy: $ref: '#/components/schemas/PriorityPolicy' priority_timeout: format: int64 type: integer type: object JSPullConsumerInfoResponse: example: cluster: leader: leader system_account: true replicas: - null - null raft_group: raft_group name: name traffic_account: traffic_account leader_since: leader_since num_redelivered: 2 paused: true created: 2000-01-23T04:56:07.000+00:00 num_pending: 2147483647 num_waiting: 4 pause_remaining: 7 delivered: consumer_seq: 2147483647 last_active: last_active stream_seq: 2147483647 num_ack_pending: 9 priority_groups: - pinned_client_id: pinned_client_id pinned_ts: 2000-01-23T04:56:07.000+00:00 group: group - pinned_client_id: pinned_client_id pinned_ts: 2000-01-23T04:56:07.000+00:00 group: group stream_name: stream_name name: name id: id config: max_waiting: 2 priority_timeout: 7 priority_groups: - priority_groups - priority_groups priority_policy: null max_expires: 5 max_bytes: 5 max_batch: 1 ack_floor: consumer_seq: 2147483647 last_active: last_active stream_seq: 2147483647 ts: 2000-01-23T04:56:07.000+00:00 properties: ack_floor: $ref: '#/components/schemas/SequenceInfo' cluster: $ref: '#/components/schemas/ClusterInfo' config: $ref: '#/components/schemas/JSPullConsumerConfigRequest' created: format: date-time type: string delivered: $ref: '#/components/schemas/SequenceInfo' id: type: string name: type: string num_ack_pending: type: integer num_pending: maximum: 18446744073709551615 minimum: 0 type: integer num_redelivered: type: integer num_waiting: type: integer pause_remaining: format: int64 type: integer paused: type: boolean priority_groups: items: $ref: '#/components/schemas/PriorityGroupState' type: array stream_name: type: string ts: format: date-time type: string required: - ack_floor - created - delivered - id - name - num_ack_pending - num_pending - num_redelivered - num_waiting - stream_name - ts type: object JSPullConsumerUpdateRequest: example: metadata: key: metadata backoff: - 6 - 6 priority_policy: null ack_wait: 0 description: description max_deliver: 7 max_bytes: 2 max_batch: 5 filter_subjects: - filter_subjects - filter_subjects max_ack_pending: 5 sample_freq: sample_freq priority_timeout: 2 priority_groups: - priority_groups - priority_groups num_replicas: 3 max_expires: 9 inactive_threshold: 1 properties: ack_wait: format: int64 type: integer backoff: items: format: int64 type: integer type: array description: type: string filter_subjects: items: type: string type: array inactive_threshold: format: int64 type: integer max_ack_pending: type: integer max_batch: type: integer max_bytes: type: integer max_deliver: type: integer max_expires: format: int64 type: integer metadata: additionalProperties: type: string type: object num_replicas: type: integer priority_groups: items: type: string type: array priority_policy: $ref: '#/components/schemas/PriorityPolicy' priority_timeout: format: int64 type: integer sample_freq: type: string type: object JSPushConsumerConfigRequest: allOf: - $ref: '#/components/schemas/JSCommonConsumerConfigRequest' example: deliver_group: deliver_group deliver_subject: deliver_subject rate_limit_bps: 2147483647 headers_only: true flow_control: true idle_heartbeat: 0 properties: deliver_group: type: string deliver_subject: description: Push based options. type: string flow_control: type: boolean headers_only: type: boolean idle_heartbeat: format: int64 type: integer rate_limit_bps: maximum: 18446744073709551615 minimum: 0 type: integer type: object JSPushConsumerInfoResponse: example: cluster: leader: leader system_account: true replicas: - null - null raft_group: raft_group name: name traffic_account: traffic_account leader_since: leader_since num_redelivered: 5 paused: true created: 2000-01-23T04:56:07.000+00:00 num_pending: 2147483647 pause_remaining: 2 delivered: consumer_seq: 2147483647 last_active: last_active stream_seq: 2147483647 num_ack_pending: 1 push_bound: true stream_name: stream_name name: name id: id config: deliver_group: deliver_group deliver_subject: deliver_subject rate_limit_bps: 2147483647 headers_only: true flow_control: true idle_heartbeat: 0 ack_floor: consumer_seq: 2147483647 last_active: last_active stream_seq: 2147483647 ts: 2000-01-23T04:56:07.000+00:00 properties: ack_floor: $ref: '#/components/schemas/SequenceInfo' cluster: $ref: '#/components/schemas/ClusterInfo' config: $ref: '#/components/schemas/JSPushConsumerConfigRequest' created: format: date-time type: string delivered: $ref: '#/components/schemas/SequenceInfo' id: type: string name: type: string num_ack_pending: type: integer num_pending: maximum: 18446744073709551615 minimum: 0 type: integer num_redelivered: type: integer pause_remaining: format: int64 type: integer paused: type: boolean push_bound: type: boolean stream_name: type: string ts: format: date-time type: string required: - ack_floor - created - delivered - id - name - num_ack_pending - num_pending - num_redelivered - stream_name - ts type: object JSPushConsumerUpdateRequest: example: metadata: key: metadata deliver_subject: deliver_subject rate_limit_bps: 2147483647 backoff: - 6 - 6 ack_wait: 0 description: description max_deliver: 5 filter_subjects: - filter_subjects - filter_subjects max_ack_pending: 5 sample_freq: sample_freq num_replicas: 2 inactive_threshold: 1 headers_only: true properties: ack_wait: format: int64 type: integer backoff: items: format: int64 type: integer type: array deliver_subject: type: string description: type: string filter_subjects: items: type: string type: array headers_only: type: boolean inactive_threshold: format: int64 type: integer max_ack_pending: type: integer max_deliver: type: integer metadata: additionalProperties: type: string type: object num_replicas: type: integer rate_limit_bps: maximum: 18446744073709551615 minimum: 0 type: integer sample_freq: type: string type: object JSShareRequest: type: object JSStreamConfigRequest: allOf: - $ref: '#/components/schemas/JSCommonStreamConfig' example: subjects: - subjects - subjects properties: subjects: items: type: string type: array type: object JSStreamConfigResponse: $ref: '#/components/schemas/JSStreamConfigRequest' JSStreamConsumerLimits: properties: inactive_threshold: format: int64 type: integer max_ack_pending: type: integer type: object JSStreamInfoListResponse: example: items: - jetstream_type: null id: id config: subjects: - subjects - subjects - jetstream_type: null id: id config: subjects: - subjects - subjects properties: items: items: $ref: '#/components/schemas/JSStreamInfoResponse' type: array required: - items type: object JSStreamInfoResponse: allOf: - $ref: '#/components/schemas/JSCommonStreamInfo' - required: - config - id - jetstream_type example: jetstream_type: null id: id config: subjects: - subjects - subjects properties: config: $ref: '#/components/schemas/JSStreamConfigRequest' id: type: string jetstream_type: $ref: '#/components/schemas/JSType' type: object JSType: enum: - stream - mirror - kv-bucket - object-bucket type: string JetStreamAPIStats: example: total: 2147483647 level: 6 errors: 2147483647 inflight: 2147483647 properties: errors: maximum: 18446744073709551615 minimum: 0 type: integer inflight: maximum: 18446744073709551615 minimum: 0 type: integer level: type: integer total: maximum: 18446744073709551615 minimum: 0 type: integer required: - errors - level - total type: object JetStreamAccountLimits: example: max_ack_pending: 6 memory_max_stream_bytes: 7 max_consumers: 1 max_streams: 2 max_bytes_required: true max_storage: 5 storage_max_stream_bytes: 9 max_memory: 5 properties: max_ack_pending: type: integer max_bytes_required: type: boolean max_consumers: type: integer max_memory: format: int64 type: integer max_storage: format: int64 type: integer max_streams: type: integer memory_max_stream_bytes: format: int64 type: integer storage_max_stream_bytes: format: int64 type: integer required: - max_ack_pending - max_bytes_required - max_consumers - max_memory - max_storage - max_streams - memory_max_stream_bytes - storage_max_stream_bytes type: object JetStreamAccountStats: description: JetStreamAccountStats returns current statistics about the account's JetStream usage. example: tiers: key: memory: 2147483647 reserved_storage: 2147483647 streams: 1 reserved_memory: 2147483647 consumers: 0 storage: 2147483647 limits: max_ack_pending: 6 memory_max_stream_bytes: 7 max_consumers: 1 max_streams: 2 max_bytes_required: true max_storage: 5 storage_max_stream_bytes: 9 max_memory: 5 domain: domain JetStreamTier: memory: 2147483647 reserved_storage: 2147483647 streams: 1 reserved_memory: 2147483647 consumers: 0 storage: 2147483647 limits: max_ack_pending: 6 memory_max_stream_bytes: 7 max_consumers: 1 max_streams: 2 max_bytes_required: true max_storage: 5 storage_max_stream_bytes: 9 max_memory: 5 api: total: 2147483647 level: 6 errors: 2147483647 inflight: 2147483647 properties: JetStreamTier: $ref: '#/components/schemas/JetStreamTier' api: $ref: '#/components/schemas/JetStreamAPIStats' domain: type: string tiers: additionalProperties: $ref: '#/components/schemas/JetStreamTier' type: object required: - JetStreamTier - api type: object JetStreamConfig: description: |- JetStreamConfig determines this server's configuration. MaxMemory and MaxStore are in bytes. properties: compress_ok: type: boolean domain: type: string max_memory: format: int64 type: integer max_storage: format: int64 type: integer store_dir: type: string required: - max_memory - max_storage type: object JetStreamLimits: example: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 properties: consumer: format: int64 type: integer disk_max_stream_bytes: format: int64 type: integer disk_storage: format: int64 type: integer max_ack_pending: format: int64 type: integer max_bytes_required: type: boolean mem_max_stream_bytes: format: int64 type: integer mem_storage: format: int64 type: integer streams: format: int64 type: integer type: object JetStreamReportResponse: description: JetStream Report Response - equivalent to 'nats server report jetstream' example: raft_meta: leader: leader size: 1 replicas: - offline: true current: true lag: 6 peer: peer name: name active_ns: 0 - offline: true current: true lag: 6 peer: peer name: name active_ns: 0 summary: total_file_bytes: 6 total_streams: 4 total_memory_bytes: 7 total_bytes: 1 total_api_requests: 1 total_consumers: 1 total_messages: 1 checks: - code: code examples: - examples - examples name: name description: description status: pass - code: code examples: - examples - examples name: name description: description status: pass servers: - cluster: cluster server: server pending: 4 streams: 7 file_bytes: 9 api_total: 5 memory_bytes: 3 is_leader: true api_errors: 5 bytes: 2 domain: domain messages: 2 consumers: 7 - cluster: cluster server: server pending: 4 streams: 7 file_bytes: 9 api_total: 5 memory_bytes: 3 is_leader: true api_errors: 5 bytes: 2 domain: domain messages: 2 consumers: 7 system_id: system_id timestamp: timestamp properties: checks: items: $ref: '#/components/schemas/ChecksSummary' type: array raft_meta: $ref: '#/components/schemas/RaftMetaInfo' servers: items: $ref: '#/components/schemas/JetStreamServerInfo' type: array summary: $ref: '#/components/schemas/JetStreamSummary' system_id: type: string timestamp: type: string required: - servers - summary - system_id - timestamp type: object JetStreamServerInfo: example: cluster: cluster server: server pending: 4 streams: 7 file_bytes: 9 api_total: 5 memory_bytes: 3 is_leader: true api_errors: 5 bytes: 2 domain: domain messages: 2 consumers: 7 properties: api_errors: type: integer api_total: type: integer bytes: type: integer cluster: type: string consumers: type: integer domain: type: string file_bytes: type: integer is_leader: type: boolean memory_bytes: type: integer messages: type: integer pending: type: integer server: type: string streams: type: integer required: - api_errors - api_total - bytes - cluster - consumers - file_bytes - is_leader - memory_bytes - messages - server - streams type: object JetStreamStats: description: Statistics about JetStream for this server. properties: accounts: type: integer api: $ref: '#/components/schemas/JetStreamAPIStats' ha_assets: type: integer memory: maximum: 18446744073709551615 minimum: 0 type: integer reserved_memory: maximum: 18446744073709551615 minimum: 0 type: integer reserved_storage: maximum: 18446744073709551615 minimum: 0 type: integer storage: maximum: 18446744073709551615 minimum: 0 type: integer required: - accounts - api - ha_assets - memory - reserved_memory - reserved_storage - storage type: object JetStreamSummary: example: total_file_bytes: 6 total_streams: 4 total_memory_bytes: 7 total_bytes: 1 total_api_requests: 1 total_consumers: 1 total_messages: 1 properties: total_api_requests: type: integer total_bytes: type: integer total_consumers: type: integer total_file_bytes: type: integer total_memory_bytes: type: integer total_messages: type: integer total_streams: type: integer required: - total_api_requests - total_bytes - total_consumers - total_file_bytes - total_memory_bytes - total_messages - total_streams type: object JetStreamTier: example: memory: 2147483647 reserved_storage: 2147483647 streams: 1 reserved_memory: 2147483647 consumers: 0 storage: 2147483647 limits: max_ack_pending: 6 memory_max_stream_bytes: 7 max_consumers: 1 max_streams: 2 max_bytes_required: true max_storage: 5 storage_max_stream_bytes: 9 max_memory: 5 properties: consumers: type: integer limits: $ref: '#/components/schemas/JetStreamAccountLimits' memory: maximum: 18446744073709551615 minimum: 0 type: integer reserved_memory: maximum: 18446744073709551615 minimum: 0 type: integer reserved_storage: maximum: 18446744073709551615 minimum: 0 type: integer storage: maximum: 18446744073709551615 minimum: 0 type: integer streams: type: integer required: - consumers - limits - memory - reserved_memory - reserved_storage - storage - streams type: object JetStreamTieredLimits: additionalProperties: $ref: '#/components/schemas/JetStreamLimits' type: object JetStreamTieredLimitsPatch: additionalProperties: $ref: '#/components/schemas/JetStreamTieredLimitsPatch_value' type: object JetStreamVarz: description: JetStreamVarz contains basic runtime information about jetstream properties: config: $ref: '#/components/schemas/JetStreamVarz_config' meta: $ref: '#/components/schemas/JetStreamVarz_meta' stats: $ref: '#/components/schemas/JetStreamVarz_stats' type: object JwtSyncStatus: enum: - InProgress - Complete - Failed type: string LeafInfo: description: LeafInfo has detailed information on each remote leafnode connection. properties: account: type: string in_bytes: format: int64 type: integer in_msgs: format: int64 type: integer ip: type: string is_spoke: type: boolean name: type: string out_bytes: format: int64 type: integer out_msgs: format: int64 type: integer port: type: integer rtt: type: string subscriptions: maximum: 4294967295 minimum: 0 type: integer subscriptions_list: items: type: string type: array required: - account - in_bytes - in_msgs - ip - name - out_bytes - out_msgs - port - subscriptions type: object Leafz: description: Leafz represents detailed information on Leafnodes. example: leafnodes: 5 leafs: - null - null now: 2000-01-23T04:56:07.000+00:00 server_id: server_id properties: leafnodes: type: integer leafs: items: $ref: '#/components/schemas/Leafz_leafs_inner' type: array now: format: date-time type: string server_id: type: string required: - leafnodes - leafs - now - server_id type: object LicenseStatusResponse: example: entitlements: http_gateway: 5 schema_registry: 7 fleet: 1 connectors: 6 insights: 5 catalog: 0 workloads: 9 protect: 2 contract_type: contract_type expires_at: 2000-01-23T04:56:07.000+00:00 grace_period_end: 2000-01-23T04:56:07.000+00:00 team_id: team_id team_name: team_name status: status properties: contract_type: type: string entitlements: $ref: '#/components/schemas/EntitlementsView' expires_at: format: date-time type: string grace_period_end: format: date-time type: string status: type: string team_id: type: string team_name: type: string required: - status type: object LicenseUpdateRequest: example: license_key: license_key properties: license_key: pattern: "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$" type: string required: - license_key type: object ListResponse: properties: schemas: items: $ref: '#/components/schemas/Schema' type: array required: - schemas type: object LostStreamData: description: LostStreamData indicates msgs that have been lost during file checks and recover due to corruption properties: bytes: description: How many bytes were lost maximum: 18446744073709551615 minimum: 0 type: integer msgs: description: Message IDs of lost messages items: maximum: 18446744073709551615 minimum: 0 type: integer type: array required: - bytes - msgs type: object Mapping: additionalProperties: items: $ref: '#/components/schemas/WeightedMapping' type: array type: object MappingPatch: additionalProperties: items: $ref: '#/components/schemas/WeightedMapping' nullable: true type: array type: object MetaClusterInfo: description: MetaClusterInfo shows information about the meta group. properties: cluster_size: type: integer leader: type: string name: type: string replicas: items: $ref: '#/components/schemas/ClusterInfo_replicas_inner' type: array required: - cluster_size type: object NatsAlertingConfig: example: receivers: - null - null subject: subject account: account properties: account: type: string receivers: items: $ref: '#/components/schemas/ReceiverConfig' type: array subject: type: string type: object NatsAlertingConfigPatch: properties: account: type: string receivers: items: $ref: '#/components/schemas/NatsAlertingConfigPatch_receivers_inner' nullable: true type: array subject: type: string type: object NatsCluster: example: incoming_gateways: 6 servers: - leaf_nodes: leafnodes: 5 leafs: - null - null now: 2000-01-23T04:56:07.000+00:00 server_id: server_id - leaf_nodes: leafnodes: 5 leafs: - null - null now: 2000-01-23T04:56:07.000+00:00 server_id: server_id name: name outgoing_gateways: 5 node_count: 1 connections: 0 properties: connections: type: integer incoming_gateways: type: integer name: type: string node_count: type: integer outgoing_gateways: type: integer servers: items: $ref: '#/components/schemas/NatsServer' type: array required: - connections - incoming_gateways - name - node_count - outgoing_gateways - servers type: object NatsClusterListResponse: example: items: - incoming_gateways: 6 servers: - leaf_nodes: leafnodes: 5 leafs: - null - null now: 2000-01-23T04:56:07.000+00:00 server_id: server_id - leaf_nodes: leafnodes: 5 leafs: - null - null now: 2000-01-23T04:56:07.000+00:00 server_id: server_id name: name outgoing_gateways: 5 node_count: 1 connections: 0 - incoming_gateways: 6 servers: - leaf_nodes: leafnodes: 5 leafs: - null - null now: 2000-01-23T04:56:07.000+00:00 server_id: server_id - leaf_nodes: leafnodes: 5 leafs: - null - null now: 2000-01-23T04:56:07.000+00:00 server_id: server_id name: name outgoing_gateways: 5 node_count: 1 connections: 0 properties: items: items: $ref: '#/components/schemas/NatsCluster' type: array required: - items type: object NatsCreateUserJwtSettings: allOf: - $ref: '#/components/schemas/Permissions' - $ref: '#/components/schemas/UserLimits' description: |- used to provide default values for create requests extention of jwt.#UserPermissionsLimits example: bearer_token: true data: 2147483647 payload: 2147483647 subs: 2147483647 allowed_connection_types: - allowed_connection_types - allowed_connection_types tags: - tags - tags properties: allowed_connection_types: items: type: string type: array bearer_token: type: boolean data: default: -1 maximum: 9223372036854775807 minimum: -1 type: integer payload: default: -1 maximum: 9223372036854775807 minimum: -1 type: integer subs: default: -1 maximum: 9223372036854775807 minimum: -1 type: integer tags: items: type: string type: array type: object NatsLimits: properties: data: format: int64 type: integer payload: format: int64 type: integer subs: format: int64 type: integer type: object NatsServer: allOf: - $ref: '#/components/schemas/ServerStatsMsg' example: leaf_nodes: leafnodes: 5 leafs: - null - null now: 2000-01-23T04:56:07.000+00:00 server_id: server_id properties: leaf_nodes: $ref: '#/components/schemas/Leafz' type: object NatsServerInfoListResponse: example: items: - cluster: cluster ver: ver domain: domain host: host name: name id: id time: 2000-01-23T04:56:07.000+00:00 jetstream: true seq: 2147483647 tags: - tags - tags - cluster: cluster ver: ver domain: domain host: host name: name id: id time: 2000-01-23T04:56:07.000+00:00 jetstream: true seq: 2147483647 tags: - tags - tags properties: items: items: $ref: '#/components/schemas/ServerInfo' type: array required: - items type: object NatsServerListResponse: example: items: - server: cluster: cluster ver: ver domain: domain host: host name: name id: id time: 2000-01-23T04:56:07.000+00:00 jetstream: true seq: 2147483647 tags: - tags - tags statsz: gateways: - null - null subscriptions: 870642708 start: 2000-01-23T04:56:07.000+00:00 cpu: 5.637376656633329 received: msgs: 9 bytes: 7 jetstream: null sent: msgs: 9 bytes: 7 routes: - null - null total_connections: 2147483647 cores: 5 mem: 2 active_accounts: 0 slow_consumers: 3 active_servers: 6 connections: 1 - server: cluster: cluster ver: ver domain: domain host: host name: name id: id time: 2000-01-23T04:56:07.000+00:00 jetstream: true seq: 2147483647 tags: - tags - tags statsz: gateways: - null - null subscriptions: 870642708 start: 2000-01-23T04:56:07.000+00:00 cpu: 5.637376656633329 received: msgs: 9 bytes: 7 jetstream: null sent: msgs: 9 bytes: 7 routes: - null - null total_connections: 2147483647 cores: 5 mem: 2 active_accounts: 0 slow_consumers: 3 active_servers: 6 connections: 1 properties: items: items: $ref: '#/components/schemas/ServerStatsMsg' type: array required: - items type: object NatsUserConnectionsListResponse: example: items: - total: 5 offset: 1 now: 2000-01-23T04:56:07.000+00:00 limit: 0 num_connections: 6 server_id: server_id connections: - null - null - total: 5 offset: 1 now: 2000-01-23T04:56:07.000+00:00 limit: 0 num_connections: 6 server_id: server_id connections: - null - null properties: items: items: $ref: '#/components/schemas/Connz' type: array required: - items type: object NatsUserCopyRequest: example: sk_group_id: sk_group_id name: name properties: name: type: string sk_group_id: type: string required: - name - sk_group_id type: object NatsUserCreateRequest: example: sk_group_id: sk_group_id jwt_settings: bearer_token: true data: 2147483647 payload: 2147483647 subs: 2147483647 allowed_connection_types: - allowed_connection_types - allowed_connection_types tags: - tags - tags name: name jwt_expires_in_secs: 0 properties: jwt_expires_in_secs: format: int64 type: integer jwt_settings: $ref: '#/components/schemas/NatsCreateUserJwtSettings' name: type: string sk_group_id: type: string required: - name - sk_group_id type: object NatsUserHTTPGWTokenCreateReply: example: token: token properties: token: type: string required: - token type: object NatsUserInfo: example: user_public_key: user_public_key name: name id: id properties: id: type: string name: type: string user_public_key: type: string required: - id - name - user_public_key type: object NatsUserIssuanceEvent: example: app_user: identifier: identifier name: name id: id type: null exp: 0 type: null iat: 6 jti: jti status: null properties: app_user: $ref: '#/components/schemas/AppUserInfo' exp: format: int64 type: integer iat: format: int64 type: integer jti: type: string status: $ref: '#/components/schemas/NatsUserIssuanceStatus' type: $ref: '#/components/schemas/NatsUserIssuanceEventType' required: - app_user - iat - jti - status - type type: object NatsUserIssuanceEventType: enum: - Import - Download - BearerJwt - HttpGwToken type: string NatsUserIssuanceInfo: example: exp_max: 6 sub: sub iat_max: 1 events_count: 0 created: 2000-01-23T04:56:07.000+00:00 iss: iss name: name id: id iat_min: 5 status: null properties: created: format: date-time type: string events_count: description: total download events for this issuance type: integer exp_max: description: "highest expiry time, undefined means Unlimited (exp not set)" format: int64 type: integer iat_max: description: most recent time this was issued format: int64 type: integer iat_min: description: first time this was issued format: int64 type: integer id: type: string iss: description: issuer account public nkey type: string name: type: string status: $ref: '#/components/schemas/NatsUserIssuanceStatus' sub: description: nats user public nkey type: string required: - created - events_count - iat_max - iat_min - id - iss - name - status - sub type: object NatsUserIssuanceStatus: description: |- NatsUserIssuanceStatus indicates status of an issuance relative to its signing key In context of issuance, status indicates following: Active - Signing key exists, and no revocations Revoked - Signing key exists, and has revocation entry with RevokedBefore > IatMax Partially Revoked - Signing key exists, and has revocation entry with IssMax > RevokedBefore > IatMin SK Disabled - Signing key is disabled SK Group Disabled - Signing key group is disabled SK Removed - Signing key no longer exists Expired - All issuances are expired In context of an issuance event, status indicates following: Active - Signing key exists, and no revocations Revoked - Signing key exists, and has revocation entry with RevokedBefore > Iat SK Disabled - Signing key is disabled SK Group Disabled - Signing key group is disabled SK Removed - Signing key no longer exists Expired - Expired time set on credential has passed enum: - Active - Revoked - Partially Revoked - SK Disabled - SK Group Disabled - SK Removed - Expired type: string NatsUserIssuanceViewResponse: example: exp_max: 1 nats: issuer_account: issuer_account sub: sub iat_max: 5 created: 2000-01-23T04:56:07.000+00:00 checksum: checksum iss: iss name: name id: id iat_min: 5 events: - app_user: identifier: identifier name: name id: id type: null exp: 0 type: null iat: 6 jti: jti status: null - app_user: identifier: identifier name: name id: id type: null exp: 0 type: null iat: 6 jti: jti status: null status: null properties: checksum: description: |- sha256 sum of (NatsUserId,Iss,Sub,Name,json_encode(Nats)) If a credential is downloaded and results in a unique checksum then a new issuance record is created. If a credential's checksum matches an existing record, a new event is appended to the existing record. type: string created: format: date-time type: string events: description: trail of download events items: $ref: '#/components/schemas/NatsUserIssuanceEvent' type: array exp_max: description: "highest expiry time, undefined means Unlimited (exp not set)" format: int64 type: integer iat_max: description: most recent time this was issued format: int64 type: integer iat_min: description: first time this was issued format: int64 type: integer id: type: string iss: description: issuer account public nkey type: string name: type: string nats: $ref: '#/components/schemas/User' status: $ref: '#/components/schemas/NatsUserIssuanceStatus' sub: description: nats user public nkey type: string required: - checksum - created - events - iat_max - iat_min - id - iss - name - nats - status - sub type: object NatsUserIssuancesListResponse: example: items: - exp_max: 6 sub: sub iat_max: 1 events_count: 0 created: 2000-01-23T04:56:07.000+00:00 iss: iss name: name id: id iat_min: 5 status: null - exp_max: 6 sub: sub iat_max: 1 events_count: 0 created: 2000-01-23T04:56:07.000+00:00 iss: iss name: name id: id iat_min: 5 status: null properties: items: items: $ref: '#/components/schemas/NatsUserIssuanceInfo' type: array required: - items type: object NatsUserJwtSettings: allOf: - $ref: '#/components/schemas/Permissions' - $ref: '#/components/schemas/UserLimits' description: |- Set correct allowed values extention of jwt.#UserPermissionsLimits example: bearer_token: true data: 2147483647 payload: 2147483647 subs: 2147483647 allowed_connection_types: - allowed_connection_types - allowed_connection_types tags: - tags - tags properties: allowed_connection_types: items: type: string type: array bearer_token: type: boolean data: maximum: 9223372036854775807 minimum: -1 type: integer payload: maximum: 9223372036854775807 minimum: -1 type: integer subs: maximum: 9223372036854775807 minimum: -1 type: integer tags: items: type: string type: array type: object NatsUserJwtSettingsPatch: example: sub: null bearer_token: true times: - start: start end: end - start: start end: end times_location: times_location data: 2147483647 payload: 2147483647 resp: null src: - src - src subs: 2147483647 allowed_connection_types: - allowed_connection_types - allowed_connection_types pub: null tags: - tags - tags properties: allowed_connection_types: items: type: string nullable: true type: array bearer_token: type: boolean data: maximum: 9223372036854775807 minimum: -1 type: integer payload: maximum: 9223372036854775807 minimum: -1 type: integer pub: $ref: '#/components/schemas/NatsUserJwtSettingsPatch_pub' resp: $ref: '#/components/schemas/NatsUserJwtSettingsPatch_resp' src: items: type: string nullable: true type: array sub: $ref: '#/components/schemas/NatsUserJwtSettingsPatch_pub' subs: maximum: 9223372036854775807 minimum: -1 type: integer tags: items: type: string nullable: true type: array times: items: $ref: '#/components/schemas/NatsUserJwtSettingsPatch_times_inner' nullable: true type: array times_location: nullable: true type: string type: object NatsUserListResponse: example: items: - sk_group_id: sk_group_id user_public_key: user_public_key created: 2000-01-23T04:56:07.000+00:00 jwt: jwt team: name: name id: id jwt_expires_at_max: 6 system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain jwt_settings: bearer_token: true data: 2147483647 payload: 2147483647 subs: 2147483647 allowed_connection_types: - allowed_connection_types - allowed_connection_types tags: - tags - tags claims: nats: issuer_account: issuer_account name: name jwt_expires_in_secs: 1 id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true - sk_group_id: sk_group_id user_public_key: user_public_key created: 2000-01-23T04:56:07.000+00:00 jwt: jwt team: name: name id: id jwt_expires_at_max: 6 system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain jwt_settings: bearer_token: true data: 2147483647 payload: 2147483647 subs: 2147483647 allowed_connection_types: - allowed_connection_types - allowed_connection_types tags: - tags - tags claims: nats: issuer_account: issuer_account name: name jwt_expires_in_secs: 1 id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true properties: items: items: $ref: '#/components/schemas/NatsUserViewResponse' type: array required: - items type: object NatsUserRevocationRequest: example: before: 0 properties: before: format: int64 type: integer required: - before type: object NatsUserRevocationViewResponse: example: user_nkey_public: user_nkey_public account_id: account_id before: 0 created: 2000-01-23T04:56:07.000+00:00 account_sk_id: account_sk_id properties: account_id: type: string account_sk_id: type: string before: format: int64 type: integer created: format: date-time type: string user_nkey_public: type: string required: - account_id - before - created - user_nkey_public type: object NatsUserUpdateRequest: example: jwt_settings: sub: null bearer_token: true times: - start: start end: end - start: start end: end times_location: times_location data: 2147483647 payload: 2147483647 resp: null src: - src - src subs: 2147483647 allowed_connection_types: - allowed_connection_types - allowed_connection_types pub: null tags: - tags - tags name: name jwt_expires_in_secs: 0 properties: jwt_expires_in_secs: format: int64 type: integer jwt_settings: $ref: '#/components/schemas/NatsUserJwtSettingsPatch' name: type: string type: object NatsUserViewResponse: example: sk_group_id: sk_group_id user_public_key: user_public_key created: 2000-01-23T04:56:07.000+00:00 jwt: jwt team: name: name id: id jwt_expires_at_max: 6 system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain jwt_settings: bearer_token: true data: 2147483647 payload: 2147483647 subs: 2147483647 allowed_connection_types: - allowed_connection_types - allowed_connection_types tags: - tags - tags claims: nats: issuer_account: issuer_account name: name jwt_expires_in_secs: 1 id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true properties: account: $ref: '#/components/schemas/AccountInfo' claims: $ref: '#/components/schemas/UserClaims' created: format: date-time type: string id: type: string jwt: type: string jwt_expires_at_max: format: int64 type: integer jwt_expires_in_secs: format: int64 type: integer jwt_settings: $ref: '#/components/schemas/NatsUserJwtSettings' name: type: string sk_group_id: type: string system: $ref: '#/components/schemas/SystemInfo' team: $ref: '#/components/schemas/TeamInfo' user_public_key: type: string required: - account - claims - created - id - jwt - jwt_expires_at_max - jwt_expires_in_secs - jwt_settings - name - system - team - user_public_key type: object Nexfile: properties: description: type: string lifecycle: type: string name: type: string start_request_schema: $ref: '#/components/schemas/StartRequestSchema' tags: additionalProperties: type: string type: object type: type: string version: type: string required: - description - lifecycle - name - start_request_schema - tags - type - version type: object ObjectStoreConfig: description: ObjectStoreConfig is the config for the object store. properties: bucket: type: string compression: description: Enable underlying stream compression. type: boolean description: type: string max_age: format: int64 type: integer max_bytes: format: int64 type: integer metadata: additionalProperties: type: string description: Bucket-specific metadata type: object num_replicas: type: integer placement: $ref: '#/components/schemas/Placement' storage: $ref: '#/components/schemas/StorageType' required: - bucket type: object OidcProviderAddRequest: example: issuer_url: issuer_url mapper: mapper label: label claims_source: claims_source client_id: client_id enabled: true microsoft_subject_source: microsoft_subject_source additional_id_token_audiences: - additional_id_token_audiences - additional_id_token_audiences requested_claims: "" provider: provider domain: domain scope: - scope - scope claims: claims auth_url: auth_url client_secret: client_secret group_role_mappings: key: team_assignments: - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name app_role: app_role token_url: token_url microsoft_tenant: microsoft_tenant properties: additional_id_token_audiences: items: type: string type: array auth_url: type: string claims: type: string claims_source: type: string client_id: type: string client_secret: type: string domain: type: string enabled: type: boolean group_role_mappings: additionalProperties: $ref: '#/components/schemas/GroupMapping' type: object issuer_url: type: string label: type: string mapper: type: string microsoft_subject_source: type: string microsoft_tenant: type: string provider: type: string requested_claims: {} scope: items: type: string type: array token_url: type: string required: - domain - enabled type: object OidcProviderDefaultsListResponse: example: items: - provider: provider claims: - claims - claims scopes: - scopes - scopes - provider: provider claims: - claims - claims scopes: - scopes - scopes properties: items: items: $ref: '#/components/schemas/OidcProviderDefaultsResponse' type: array required: - items type: object OidcProviderDefaultsResponse: example: provider: provider claims: - claims - claims scopes: - scopes - scopes properties: claims: items: type: string type: array provider: type: string scopes: items: type: string type: array required: - claims - provider - scopes type: object OidcProviderListResponse: example: items: - issuer_url: issuer_url created: 2000-01-23T04:56:07.000+00:00 mapper: mapper label: label claims_source: claims_source client_id: client_id enabled: true microsoft_subject_source: microsoft_subject_source additional_id_token_audiences: - additional_id_token_audiences - additional_id_token_audiences requested_claims: "" provider: provider domain: domain scope: - scope - scope claims: claims auth_url: auth_url id: id group_role_mappings: key: team_assignments: - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name app_role: app_role token_url: token_url microsoft_tenant: microsoft_tenant - issuer_url: issuer_url created: 2000-01-23T04:56:07.000+00:00 mapper: mapper label: label claims_source: claims_source client_id: client_id enabled: true microsoft_subject_source: microsoft_subject_source additional_id_token_audiences: - additional_id_token_audiences - additional_id_token_audiences requested_claims: "" provider: provider domain: domain scope: - scope - scope claims: claims auth_url: auth_url id: id group_role_mappings: key: team_assignments: - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name app_role: app_role token_url: token_url microsoft_tenant: microsoft_tenant properties: items: items: $ref: '#/components/schemas/OidcProviderViewResponse' type: array required: - items type: object OidcProviderUpdateRequest: example: issuer_url: issuer_url mapper: mapper label: label claims_source: claims_source client_id: client_id enabled: true microsoft_subject_source: microsoft_subject_source additional_id_token_audiences: - additional_id_token_audiences - additional_id_token_audiences requested_claims: "" provider: provider scope: - scope - scope claims: claims auth_url: auth_url client_secret: client_secret group_role_mappings: key: team_assignments: - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name app_role: app_role token_url: token_url microsoft_tenant: microsoft_tenant properties: additional_id_token_audiences: items: type: string type: array auth_url: type: string claims: type: string claims_source: type: string client_id: type: string client_secret: type: string enabled: type: boolean group_role_mappings: additionalProperties: $ref: '#/components/schemas/GroupMapping' type: object issuer_url: type: string label: type: string mapper: type: string microsoft_subject_source: type: string microsoft_tenant: type: string provider: type: string requested_claims: {} scope: items: type: string type: array token_url: type: string type: object OidcProviderViewResponse: example: issuer_url: issuer_url created: 2000-01-23T04:56:07.000+00:00 mapper: mapper label: label claims_source: claims_source client_id: client_id enabled: true microsoft_subject_source: microsoft_subject_source additional_id_token_audiences: - additional_id_token_audiences - additional_id_token_audiences requested_claims: "" provider: provider domain: domain scope: - scope - scope claims: claims auth_url: auth_url id: id group_role_mappings: key: team_assignments: - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name - role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name app_role: app_role token_url: token_url microsoft_tenant: microsoft_tenant properties: additional_id_token_audiences: items: type: string type: array auth_url: type: string claims: type: string claims_source: type: string client_id: type: string created: format: date-time type: string domain: type: string enabled: type: boolean group_role_mappings: additionalProperties: $ref: '#/components/schemas/GroupMapping' type: object id: type: string issuer_url: type: string label: type: string mapper: type: string microsoft_subject_source: type: string microsoft_tenant: type: string provider: type: string requested_claims: {} scope: items: type: string type: array token_url: type: string required: - created - domain - enabled - id type: object Operator: allOf: - $ref: '#/components/schemas/GenericFields' description: Operator specific claims example: system_account: system_account signing_keys: - signing_keys - signing_keys strict_signing_key_usage: true operator_service_urls: - operator_service_urls - operator_service_urls assert_server_version: assert_server_version account_server_url: account_server_url properties: account_server_url: description: |- AccountServerURL is a partial URL like "https://host.domain.org:/jwt/v1" tools will use the prefix and build queries by appending /accounts/ or /operator to the path provided. Note this assumes that the account server can handle requests in a account-server compatible way. See https://github.com/nats-io/account-server. type: string assert_server_version: description: Min Server version type: string operator_service_urls: description: |- A list of NATS urls (tls://host:port) where tools can connect to the server using proper credentials. items: type: string type: array signing_keys: description: |- Slice of other operator NKeys that can be used to sign on behalf of the main operator identity. items: type: string type: array strict_signing_key_usage: description: Signing of subordinate objects will require signing keys type: boolean system_account: description: Identity of the system account type: string type: object OperatorClaims: allOf: - $ref: '#/components/schemas/ClaimsData' description: OperatorClaims define the data for an operator JWT example: nats: system_account: system_account signing_keys: - signing_keys - signing_keys strict_signing_key_usage: true operator_service_urls: - operator_service_urls - operator_service_urls assert_server_version: assert_server_version account_server_url: account_server_url properties: nats: $ref: '#/components/schemas/Operator' type: object OperatorExport: example: seed: seed jwt: jwt name: name signing_keys: - seed: seed id: id - seed: seed id: id id: id properties: id: type: string jwt: type: string name: type: string seed: type: string signing_keys: items: $ref: '#/components/schemas/SigningKeyExport' type: array required: - id - jwt - name type: object OperatorLimits: allOf: - $ref: '#/components/schemas/NatsLimits' - $ref: '#/components/schemas/AccountLimits' - $ref: '#/components/schemas/JetStreamLimits' description: OperatorLimits are used to limit access by an account example: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 properties: tiered_limits: additionalProperties: $ref: '#/components/schemas/JetStreamLimits' type: object type: object OperatorLimitsPatch: properties: conn: format: int64 type: integer consumer: format: int64 type: integer data: format: int64 type: integer disallow_bearer: type: boolean disk_max_stream_bytes: format: int64 type: integer disk_storage: format: int64 type: integer exports: format: int64 type: integer imports: format: int64 type: integer leaf: format: int64 type: integer max_ack_pending: format: int64 type: integer max_bytes_required: type: boolean mem_max_stream_bytes: format: int64 type: integer mem_storage: format: int64 type: integer payload: format: int64 type: integer streams: format: int64 type: integer subs: format: int64 type: integer tiered_limits: allOf: - $ref: '#/components/schemas/JetStreamTieredLimitsPatch' nullable: true type: object wildcards: type: boolean type: object PeerInfo: description: |- PeerInfo shows information about all the peers in the cluster that are supporting the stream or consumer. properties: active: format: int64 type: integer current: type: boolean lag: maximum: 18446744073709551615 minimum: 0 type: integer name: type: string offline: type: boolean peer: type: string required: - active - current - name - peer type: object Permission: description: Permission defines allow/deny subjects example: allow: - allow - allow deny: - deny - deny properties: allow: items: type: string type: array deny: items: type: string type: array type: object PermissionPatch: properties: allow: items: type: string nullable: true type: array deny: items: type: string nullable: true type: array type: object Permissions: description: "Permissions are used to restrict subject access, either on a user\ \ or for everyone on a server by default" example: sub: allow: - allow - allow deny: - deny - deny resp: max: 0 ttl: 6 pub: allow: - allow - allow deny: - deny - deny properties: pub: $ref: '#/components/schemas/Permission' resp: $ref: '#/components/schemas/ResponsePermission' sub: $ref: '#/components/schemas/Permission' type: object Placement: description: Placement describes stream placement requirements for a stream or leader. example: cluster: cluster tags: - tags - tags properties: cluster: type: string tags: items: type: string type: array type: object PlatformComponent: example: id: id type: null config: null enabled: true properties: config: $ref: '#/components/schemas/PlatformComponentConfigs' enabled: type: boolean id: type: string type: $ref: '#/components/schemas/PlatformComponentType' required: - enabled - id - type type: object PlatformComponentConfigs: nullable: true oneOf: - $ref: '#/components/schemas/HttpGatewayPlatformComponentConfig' - $ref: '#/components/schemas/AuthCalloutAuthenticatorComponentConfig' - $ref: '#/components/schemas/WorkloadsPlatformComponentConfig' - $ref: '#/components/schemas/ScraperComponentConfig' - $ref: '#/components/schemas/CatalogPlatformComponentConfig' type: object PlatformComponentConnectConfig: nullable: true oneOf: - $ref: '#/components/schemas/HttpGatewayPlatformComponentConfig' - $ref: '#/components/schemas/AuthCalloutAuthenticatorComponentConfig' type: object PlatformComponentTokenViewResponse: example: last_access: 2000-01-23T04:56:07.000+00:00 created: 2000-01-23T04:56:07.000+00:00 id: id token: token properties: created: format: date-time type: string id: type: string last_access: format: date-time type: string token: type: string required: - created - id - token type: object PlatformComponentType: enum: - http_gateway - connectors - authenticators - workloads - scraper - schema_registry - safe - insights - catalog type: string PlatformComponentsConfigSchema: example: data: data name: name type: 0 required: true properties: data: type: string name: type: string required: type: boolean type: type: integer required: - name - required - type type: object PlatformComponentsConnectRequest: example: data: null nkey_public: nkey_public properties: data: $ref: '#/components/schemas/PlatformComponentConnectConfig' nkey_public: type: string required: - nkey_public type: object PlatformComponentsConnectViewResponse: example: server: server jwt: jwt config: null account: account properties: account: type: string config: $ref: '#/components/schemas/PlatformComponentConfigs' jwt: type: string server: type: string required: - account - jwt - server type: object PlatformComponentsUpdateRequest: example: type: null config: null enabled: true properties: config: $ref: '#/components/schemas/PlatformComponentConfigs' enabled: type: boolean type: $ref: '#/components/schemas/PlatformComponentType' required: - enabled - type type: object PlatformComponentsViewResponse: example: components: - id: id type: null config: null enabled: true - id: id type: null config: null enabled: true system_id: system_id properties: components: items: $ref: '#/components/schemas/PlatformComponent' type: array system_id: type: string required: - components - system_id type: object PolicyListResponse: example: items: - name: name description: description statements: key: resource: - resource - resource service: service effect: - null - null name: name action: - action - action operation_id: operation_id group: null - name: name description: description statements: key: resource: - resource - resource service: service effect: - null - null name: name action: - action - action operation_id: operation_id group: null properties: items: items: $ref: '#/components/schemas/AppPolicy' type: array required: - items type: object PriorityGroupState: description: PriorityGroupState is the state of a consumer priority group. example: pinned_client_id: pinned_client_id pinned_ts: 2000-01-23T04:56:07.000+00:00 group: group properties: group: type: string pinned_client_id: type: string pinned_ts: format: date-time type: string required: - group type: object PriorityPolicy: description: PriorityPolicy determines how messages are selected from priority groups. enum: - none - overflow - pinned_client - prioritized type: string PromSampleValue: example: value: 1.4658129805029452 timestamp: 6 properties: timestamp: format: int64 type: integer value: format: double type: number required: - timestamp - value type: object RaftMetaInfo: example: leader: leader size: 1 replicas: - offline: true current: true lag: 6 peer: peer name: name active_ns: 0 - offline: true current: true lag: 6 peer: peer name: name active_ns: 0 properties: leader: type: string replicas: items: $ref: '#/components/schemas/RaftReplica' type: array size: type: integer required: - leader - replicas - size type: object RaftReplica: example: offline: true current: true lag: 6 peer: peer name: name active_ns: 0 properties: active_ns: type: integer current: type: boolean lag: type: integer name: type: string offline: type: boolean peer: type: string required: - active_ns - current - lag - name - offline - peer type: object RaftSummary: example: empty_wal_groups: 2 healthy_groups: 4 leaderless_groups: 7 out_of_sync_groups: 1 total_groups: 1 wal_error_groups: 1 properties: empty_wal_groups: type: integer healthy_groups: type: integer leaderless_groups: type: integer out_of_sync_groups: type: integer total_groups: type: integer wal_error_groups: type: integer required: - empty_wal_groups - healthy_groups - leaderless_groups - out_of_sync_groups - total_groups - wal_error_groups type: object RePublish: description: RePublish allows a source subject to be mapped to a destination subject for republishing. example: src: src headers_only: true dest: dest properties: dest: type: string headers_only: type: boolean src: type: string required: - dest type: object ReceiverConfig: $ref: '#/components/schemas/SlackReceiverConfig' RemoveRequest: properties: format: description: Format is optional and can be in payload type: string name: description: "Name of the schema (set from subject, not from JSON payload)." type: string revision: description: "Revision of the schema (set from subject, not from JSON payload)." type: integer version: description: "Version of the schema (set from subject, not from JSON payload)." type: integer type: object ReplayPolicy: enum: - instant - original type: string ResponsePermission: description: |- ResponsePermission can be used to allow responses to any reply subject that is received on a valid subscription. example: max: 0 ttl: 6 properties: max: type: integer ttl: format: int64 type: integer required: - max - ttl type: object ResponsePermissionPatch: properties: max: type: integer ttl: format: int64 type: integer type: object ResponseType: description: ResponseType is used to store an export response type enum: - Singleton - Stream - Chunked type: string RetentionPolicy: enum: - limits - interest - workqueue type: string RevocationList: additionalProperties: format: int64 type: integer description: RevocationList is used to store a mapping of public keys to unix timestamps type: object RevocationListPatch: additionalProperties: maximum: 9223372036854775807 minimum: -9223372036854775808 nullable: true type: integer type: object RoleListResponse: example: items: - scope: null name: name policies: - policies - policies description: description id: id sort_order: 0.8008281904610115 enabled: true - scope: null name: name policies: - policies - policies description: description id: id sort_order: 0.8008281904610115 enabled: true properties: items: items: $ref: '#/components/schemas/AppRole' type: array required: - items type: object RouteStat: description: RouteStat holds route statistics. properties: name: type: string pending: type: integer received: $ref: '#/components/schemas/DataStats' rid: maximum: 18446744073709551615 minimum: 0 type: integer sent: $ref: '#/components/schemas/DataStats' required: - pending - received - rid - sent type: object SDKubeLimit: properties: five_node: type: integer three_node: type: integer required: - five_node - three_node type: object SafeComponentConfig: properties: account: type: string required: - account type: object SamplingRate: maximum: 100 minimum: 0 type: integer Schema: properties: compat_policy: description: |- SchemaCompatPolicy represents the compatibility policy for schema evolution. Supported values are "none", "backwards", "forward", and "full". type: string definition: description: The schema definition. type: string delete: description: Deleted is a flag to indicate if the schema is deleted. type: boolean description: description: Description of the schema. type: string format: description: |- SchemaFormat represents the format of a schema definition. Supported values are "jsonschema". type: string metadata: additionalProperties: type: string description: Metadata is a map of key-value pairs. type: object name: description: Unique name of the schema. type: string revision: description: Revision of the schema. type: integer time: description: Timestamp when this schema was added. format: date-time type: string version: description: |- TODO(jrm): We probably do not need the ID, as we can use subject + version as a compound unique identifier. Unique identifier of the schema. ID string `json:"id"` type: integer required: - compat_policy - definition - description - format - metadata - name - revision - time - version type: object SchemaCompatPolicy: description: |- SchemaCompatPolicy represents the compatibility policy for schema evolution. Supported values are "none", "backwards", "forward", and "full". type: string SchemaFormat: description: |- SchemaFormat represents the format of a schema definition. Supported values are "jsonschema". type: string SchemaRegistryAddRequest: $ref: '#/components/schemas/AddRequest' SchemaRegistryAddResponse: $ref: '#/components/schemas/AddResponse' SchemaRegistryCompatPolicy: default: backwards enum: - backwards - none - forward - full type: string SchemaRegistryFormat: default: jsonschema enum: - jsonschema - protobuf - avro type: string SchemaRegistryGetResponse: $ref: '#/components/schemas/GetResponse' SchemaRegistryListResponse: $ref: '#/components/schemas/ListResponse' SchemaRegistryPlatformComponentConfig: properties: account: type: string bucket: type: string required: - account - bucket type: object SchemaRegistryRemoveRequest: $ref: '#/components/schemas/RemoveRequest' SchemaRegistrySchema: $ref: '#/components/schemas/Schema' SchemaRegistryUpdateRequest: $ref: '#/components/schemas/UpdateRequest' SchemaRegistryUpdateResponse: $ref: '#/components/schemas/UpdateResponse' SchemaRegistryValidateRequest: $ref: '#/components/schemas/ValidateRequest' SchemaRegistryValidateResponse: $ref: '#/components/schemas/ValidateResponse' ScraperComponentConfig: properties: account: type: string interval: default: 15 minimum: 0 type: integer stream: type: string required: - account - interval - stream type: object SequenceInfo: description: SequenceInfo is the consumer and stream sequence that uniquely identify a message example: consumer_seq: 2147483647 last_active: last_active stream_seq: 2147483647 properties: consumer_seq: maximum: 18446744073709551615 minimum: 0 type: integer last_active: nullable: true type: string stream_seq: maximum: 18446744073709551615 minimum: 0 type: integer required: - consumer_seq - stream_seq type: object ServerHealthInfo: example: cluster: cluster server: server status_code: 0 domain: domain errors: - error: error type: type - error: error type: type status: ok properties: cluster: type: string domain: type: string errors: items: $ref: '#/components/schemas/HealthError' type: array server: type: string status: enum: - ok - error type: string status_code: type: integer required: - cluster - server - status - status_code type: object ServerInfo: description: ServerInfo identifies remote servers. example: cluster: cluster ver: ver domain: domain host: host name: name id: id time: 2000-01-23T04:56:07.000+00:00 jetstream: true seq: 2147483647 tags: - tags - tags properties: cluster: type: string domain: type: string host: type: string id: type: string jetstream: type: boolean name: type: string seq: maximum: 18446744073709551615 minimum: 0 type: integer tags: items: type: string type: array time: format: date-time type: string ver: type: string required: - host - id - jetstream - name - seq - time - ver type: object ServerListInfo: example: cluster: cluster gateways: 5 slow_consumer_stats: gateways: 9 routes: 2 clients: 7 leafs: 3 subscriptions: 7 uptime_ns: 1 memory_bytes: 5 jetstream: true version: version routes: 2 start_time: start_time cores: 6 host: host name: name slow_consumers: 4 id: id connections: 0 jetstream_domain: jetstream_domain cpu_percent: 1.4658129805029452 properties: cluster: type: string connections: type: integer cores: type: integer cpu_percent: type: number gateways: type: integer host: type: string id: type: string jetstream: type: boolean jetstream_domain: type: string memory_bytes: type: integer name: type: string routes: type: integer slow_consumer_stats: $ref: '#/components/schemas/SlowConsumerStats' slow_consumers: type: integer start_time: type: string subscriptions: type: integer uptime_ns: type: integer version: type: string required: - connections - cores - cpu_percent - gateways - host - id - jetstream - memory_bytes - name - routes - slow_consumers - start_time - subscriptions - uptime_ns - version type: object ServerListResponse: description: Server List Response - equivalent to 'nats server ls' example: summary: total_slow_consumers: 4 total_connections: 6 jetstream_servers: 1 total_memory_bytes: 7 total_clusters: 1 total_servers: 1 total_subscriptions: 5 checks: - code: code examples: - examples - examples name: name description: description status: pass - code: code examples: - examples - examples name: name description: description status: pass servers: - cluster: cluster gateways: 5 slow_consumer_stats: gateways: 9 routes: 2 clients: 7 leafs: 3 subscriptions: 7 uptime_ns: 1 memory_bytes: 5 jetstream: true version: version routes: 2 start_time: start_time cores: 6 host: host name: name slow_consumers: 4 id: id connections: 0 jetstream_domain: jetstream_domain cpu_percent: 1.4658129805029452 - cluster: cluster gateways: 5 slow_consumer_stats: gateways: 9 routes: 2 clients: 7 leafs: 3 subscriptions: 7 uptime_ns: 1 memory_bytes: 5 jetstream: true version: version routes: 2 start_time: start_time cores: 6 host: host name: name slow_consumers: 4 id: id connections: 0 jetstream_domain: jetstream_domain cpu_percent: 1.4658129805029452 system_id: system_id clusters: - leader: leader system_account: true replicas: - null - null raft_group: raft_group name: name traffic_account: traffic_account leader_since: leader_since - leader: leader system_account: true replicas: - null - null raft_group: raft_group name: name traffic_account: traffic_account leader_since: leader_since timestamp: timestamp properties: checks: items: $ref: '#/components/schemas/ChecksSummary' type: array clusters: items: $ref: '#/components/schemas/ClusterInfo' type: array servers: items: $ref: '#/components/schemas/ServerListInfo' type: array summary: $ref: '#/components/schemas/ServerSummary' system_id: type: string timestamp: type: string required: - servers - summary - system_id - timestamp type: object ServerStats: description: ServerStats hold various statistics that we will periodically send out. example: gateways: - null - null subscriptions: 870642708 start: 2000-01-23T04:56:07.000+00:00 cpu: 5.637376656633329 received: msgs: 9 bytes: 7 jetstream: null sent: msgs: 9 bytes: 7 routes: - null - null total_connections: 2147483647 cores: 5 mem: 2 active_accounts: 0 slow_consumers: 3 active_servers: 6 connections: 1 properties: active_accounts: type: integer active_servers: type: integer connections: type: integer cores: type: integer cpu: format: double type: number gateways: items: $ref: '#/components/schemas/ServerStats_gateways_inner' type: array jetstream: $ref: '#/components/schemas/ServerStats_jetstream' mem: format: int64 type: integer received: $ref: '#/components/schemas/DataStats' routes: items: $ref: '#/components/schemas/ServerStats_routes_inner' type: array sent: $ref: '#/components/schemas/DataStats' slow_consumers: format: int64 type: integer start: format: date-time type: string subscriptions: maximum: 4294967295 minimum: 0 type: integer total_connections: maximum: 18446744073709551615 minimum: 0 type: integer required: - active_accounts - connections - cores - cpu - mem - received - sent - slow_consumers - start - subscriptions - total_connections type: object ServerStatsMsg: description: ServerStatsMsg is sent periodically with stats updates. example: server: cluster: cluster ver: ver domain: domain host: host name: name id: id time: 2000-01-23T04:56:07.000+00:00 jetstream: true seq: 2147483647 tags: - tags - tags statsz: gateways: - null - null subscriptions: 870642708 start: 2000-01-23T04:56:07.000+00:00 cpu: 5.637376656633329 received: msgs: 9 bytes: 7 jetstream: null sent: msgs: 9 bytes: 7 routes: - null - null total_connections: 2147483647 cores: 5 mem: 2 active_accounts: 0 slow_consumers: 3 active_servers: 6 connections: 1 properties: server: $ref: '#/components/schemas/ServerInfo' statsz: $ref: '#/components/schemas/ServerStats' required: - server - statsz type: object ServerSummary: example: total_slow_consumers: 4 total_connections: 6 jetstream_servers: 1 total_memory_bytes: 7 total_clusters: 1 total_servers: 1 total_subscriptions: 5 properties: jetstream_servers: type: integer total_clusters: type: integer total_connections: type: integer total_memory_bytes: type: integer total_servers: type: integer total_slow_consumers: type: integer total_subscriptions: type: integer required: - jetstream_servers - total_clusters - total_connections - total_memory_bytes - total_servers - total_slow_consumers - total_subscriptions type: object ServiceAccountCreateRequest: example: role_id: role_id name: name resources: key: role_id: role_id properties: name: type: string resources: additionalProperties: $ref: '#/components/schemas/AppUserAssignRequest' description: resource keys must be in format ServiceAccountResourceScope:resource_id type: object role_id: type: string required: - name - resources - role_id type: object ServiceAccountListResponse: example: items: - role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null name: name resources: key: role_name: role_name nats_user: user_public_key: user_public_key name: name id: id system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null team_app_user: role_name: role_name role_id: role_id pending_invitation: true id: id resource_id: resource_id team: name: name id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true id: id last_active: last_active team_id: team_id - role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null name: name resources: key: role_name: role_name nats_user: user_public_key: user_public_key name: name id: id system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null team_app_user: role_name: role_name role_id: role_id pending_invitation: true id: id resource_id: resource_id team: name: name id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true id: id last_active: last_active team_id: team_id properties: items: items: $ref: '#/components/schemas/ServiceAccountViewResponse' type: array required: - items type: object ServiceAccountResourceScope: enum: - Team - System - Account - NatsUser type: string ServiceAccountScope: enum: - App - Team type: string ServiceAccountUpdateRequest: example: role_id: role_id name: name resources: key: null properties: name: type: string resources: additionalProperties: $ref: '#/components/schemas/ServiceAccountUpdateRequest_resources_value' description: |- Resource keys must be in format ServiceAccountResourceScope:resource_id. To delete a resource, set its key to null type: object role_id: type: string type: object ServiceAccountViewResponse: example: role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null name: name resources: key: role_name: role_name nats_user: user_public_key: user_public_key name: name id: id system: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 scope: null team_app_user: role_name: role_name role_id: role_id pending_invitation: true id: id resource_id: resource_id team: name: name id: id account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true id: id last_active: last_active team_id: team_id properties: created: format: date-time type: string id: type: string last_active: nullable: true type: string name: type: string resources: additionalProperties: $ref: '#/components/schemas/AppUserAssignResponse' description: resource keys must be in format ServiceAccountResourceScope:resource_id type: object role_id: type: string scope: $ref: '#/components/schemas/ServiceAccountScope' team_id: type: string required: - created - id - last_active - name - resources - role_id - scope type: object ServiceLatency: description: |- ServiceLatency is used when observing and exported service for latency measurements. Sampling 1-100, represents sampling rate, defaults to 100. Results is the subject where the latency metrics are published. A metric will be defined by the nats-server's ServiceLatency. Time durations are in nanoseconds. see https://github.com/nats-io/nats-server/blob/main/server/accounts.go#L524 e.g. { "app": "dlc22", "start": "2019-09-16T21:46:23.636869585-07:00", "svc": 219732, "nats": { "req": 320415, "resp": 228268, "sys": 0 }, "total": 768415 } example: sampling: 23 results: results properties: results: type: string sampling: maximum: 100 minimum: 0 type: integer required: - results - sampling type: object ServiceLatencyPatch: properties: results: type: string sampling: maximum: 100 minimum: 0 type: integer type: object SigningKeyExport: example: seed: seed id: id properties: id: type: string seed: type: string required: - id - seed type: object SigningKeyGroupCopyRequest: example: name: name properties: name: type: string required: - name type: object SigningKeyGroupCreateRequest: example: seed: seed programmatic: false scope: bearer_token: true allowed_connection_types: - allowed_connection_types - allowed_connection_types name: name properties: name: type: string programmatic: default: false type: boolean scope: $ref: '#/components/schemas/UserPermissionLimits' seed: type: string required: - name - programmatic type: object SigningKeyGroupCreateResponse: allOf: - $ref: '#/components/schemas/SigningKeyGroupViewResponse' example: seed: seed properties: seed: type: string type: object SigningKeyGroupExport: example: name: name signing_keys: - seed: seed id: id - seed: seed id: id properties: name: type: string signing_keys: items: $ref: '#/components/schemas/SigningKeyExport' type: array required: - name - signing_keys type: object SigningKeyGroupListResponse: example: items: - missing_seed: true created: 2000-01-23T04:56:07.000+00:00 disabled_at: 2000-01-23T04:56:07.000+00:00 programmatic: true scope: bearer_token: true allowed_connection_types: - allowed_connection_types - allowed_connection_types is_scoped: true name: name disabled: true id: id - missing_seed: true created: 2000-01-23T04:56:07.000+00:00 disabled_at: 2000-01-23T04:56:07.000+00:00 programmatic: true scope: bearer_token: true allowed_connection_types: - allowed_connection_types - allowed_connection_types is_scoped: true name: name disabled: true id: id properties: items: items: $ref: '#/components/schemas/SigningKeyGroupViewResponse' type: array required: - items type: object SigningKeyGroupUpdateRequest: example: scope: sub: null bearer_token: true times: - start: start end: end - start: start end: end times_location: times_location data: 0 payload: 6 resp: null src: - src - src subs: 1 allowed_connection_types: - allowed_connection_types - allowed_connection_types pub: null name: name disabled: true properties: disabled: type: boolean name: type: string scope: $ref: '#/components/schemas/UserPermissionLimitsPatch' type: object SigningKeyGroupViewResponse: example: missing_seed: true created: 2000-01-23T04:56:07.000+00:00 disabled_at: 2000-01-23T04:56:07.000+00:00 programmatic: true scope: bearer_token: true allowed_connection_types: - allowed_connection_types - allowed_connection_types is_scoped: true name: name disabled: true id: id properties: created: format: date-time type: string disabled: type: boolean disabled_at: format: date-time type: string id: type: string is_scoped: type: boolean missing_seed: type: boolean name: type: string programmatic: type: boolean scope: $ref: '#/components/schemas/UserPermissionLimits' required: - created - disabled - id - is_scoped - missing_seed - name - programmatic type: object SigningKeyListResponse: example: items: - public_key: public_key current: true missing_seed: true group_id: group_id created: 2000-01-23T04:56:07.000+00:00 disabled_at: 2000-01-23T04:56:07.000+00:00 rotated: true disabled: true id: id rotated_at: 2000-01-23T04:56:07.000+00:00 - public_key: public_key current: true missing_seed: true group_id: group_id created: 2000-01-23T04:56:07.000+00:00 disabled_at: 2000-01-23T04:56:07.000+00:00 rotated: true disabled: true id: id rotated_at: 2000-01-23T04:56:07.000+00:00 properties: items: items: $ref: '#/components/schemas/SigningKeyViewResponse' type: array required: - items type: object SigningKeyRotateResponse: allOf: - $ref: '#/components/schemas/SigningKeyViewResponse' example: seed: seed properties: seed: type: string type: object SigningKeyScope: properties: key: type: string kind: $ref: '#/components/schemas/SigningKeyScopeType' role: type: string template: $ref: '#/components/schemas/UserPermissionLimits' required: - key - kind - role - template type: object SigningKeyScopeType: enum: - user_scope type: string SigningKeyUpdateRequest: example: seed: seed disabled: true properties: disabled: type: boolean seed: type: string type: object SigningKeyViewResponse: example: public_key: public_key current: true missing_seed: true group_id: group_id created: 2000-01-23T04:56:07.000+00:00 disabled_at: 2000-01-23T04:56:07.000+00:00 rotated: true disabled: true id: id rotated_at: 2000-01-23T04:56:07.000+00:00 properties: created: format: date-time type: string current: type: boolean disabled: type: boolean disabled_at: format: date-time type: string group_id: type: string id: type: string missing_seed: type: boolean public_key: type: string rotated: type: boolean rotated_at: format: date-time type: string required: - created - current - disabled - group_id - id - missing_seed - public_key - rotated type: object SigningKeys: description: "SigningKeys an array of either String or #SigningKeyScope" items: $ref: '#/components/schemas/SigningKeys_inner' type: array SlackConfig: properties: channel: type: string token: type: string required: - channel - token type: object SlackReceiverConfig: properties: config: $ref: '#/components/schemas/SlackConfig' type: enum: - slack type: string required: - config - type type: object SlowConsumerStats: example: gateways: 9 routes: 2 clients: 7 leafs: 3 properties: clients: type: integer gateways: type: integer leafs: type: integer routes: type: integer required: - clients - gateways - leafs - routes type: object StartRequestSchema: properties: inputs: {} template: {} required: - inputs - template type: object StorageType: enum: - file - memory type: string StreamAlternate: properties: cluster: type: string domain: type: string name: type: string required: - cluster - name type: object StreamConsumerSource: description: StreamConsumerSource configures the consumer used by a sourced stream. properties: deliver_subject: type: string name: type: string required: - deliver_subject type: object StreamExportCreateRequest: example: stream_name: stream_name is_public: true properties: is_public: type: boolean stream_name: type: string required: - is_public - stream_name type: object StreamExportListResponse: example: items: - account_id: account_id stream_name: stream_name created: 2000-01-23T04:56:07.000+00:00 js_subject_prefix: js_subject_prefix is_public: true deliver_subject_prefix: deliver_subject_prefix id: id - account_id: account_id stream_name: stream_name created: 2000-01-23T04:56:07.000+00:00 js_subject_prefix: js_subject_prefix is_public: true deliver_subject_prefix: deliver_subject_prefix id: id properties: items: items: $ref: '#/components/schemas/StreamExportViewResponse' type: array required: - items type: object StreamExportSharedListResponse: example: items: - remote_account_nkey_public: remote_account_nkey_public stream_name: stream_name js_subject_prefix: js_subject_prefix is_public: true deliver_subject_prefix: deliver_subject_prefix - remote_account_nkey_public: remote_account_nkey_public stream_name: stream_name js_subject_prefix: js_subject_prefix is_public: true deliver_subject_prefix: deliver_subject_prefix properties: items: items: $ref: '#/components/schemas/StreamExportSharedViewResponse' type: array required: - items type: object StreamExportSharedViewResponse: example: remote_account_nkey_public: remote_account_nkey_public stream_name: stream_name js_subject_prefix: js_subject_prefix is_public: true deliver_subject_prefix: deliver_subject_prefix properties: deliver_subject_prefix: type: string is_public: type: boolean js_subject_prefix: type: string remote_account_nkey_public: type: string stream_name: type: string required: - deliver_subject_prefix - is_public - js_subject_prefix - remote_account_nkey_public - stream_name type: object StreamExportViewResponse: description: |- / Stream export / example: account_id: account_id stream_name: stream_name created: 2000-01-23T04:56:07.000+00:00 js_subject_prefix: js_subject_prefix is_public: true deliver_subject_prefix: deliver_subject_prefix id: id properties: account_id: type: string created: format: date-time type: string deliver_subject_prefix: type: string id: type: string is_public: type: boolean js_subject_prefix: type: string stream_name: type: string required: - account_id - created - deliver_subject_prefix - id - is_public - js_subject_prefix - stream_name type: object StreamImportCreateRequest: example: remote_account_nkey_public: remote_account_nkey_public stream_name: stream_name js_subject_prefix: js_subject_prefix is_public: true deliver_subject_prefix: deliver_subject_prefix properties: deliver_subject_prefix: type: string is_public: type: boolean js_subject_prefix: type: string remote_account_nkey_public: type: string stream_name: type: string required: - deliver_subject_prefix - is_public - js_subject_prefix - remote_account_nkey_public - stream_name type: object StreamImportListResponse: example: items: - remote_account_nkey_public: remote_account_nkey_public account_id: account_id deliver_subject: deliver_subject stream_name: stream_name created: 2000-01-23T04:56:07.000+00:00 js_subject_prefix: js_subject_prefix id: id - remote_account_nkey_public: remote_account_nkey_public account_id: account_id deliver_subject: deliver_subject stream_name: stream_name created: 2000-01-23T04:56:07.000+00:00 js_subject_prefix: js_subject_prefix id: id properties: items: items: $ref: '#/components/schemas/StreamImportViewResponse' type: array required: - items type: object StreamImportViewResponse: description: |- / Stream Import / example: remote_account_nkey_public: remote_account_nkey_public account_id: account_id deliver_subject: deliver_subject stream_name: stream_name created: 2000-01-23T04:56:07.000+00:00 js_subject_prefix: js_subject_prefix id: id properties: account_id: type: string created: format: date-time type: string deliver_subject: type: string id: type: string js_subject_prefix: type: string remote_account_nkey_public: type: string stream_name: type: string required: - account_id - created - deliver_subject - id - js_subject_prefix - remote_account_nkey_public - stream_name type: object StreamShareCreateRequest: description: |- / Stream Share / example: target_account_nkey_public: target_account_nkey_public properties: target_account_nkey_public: type: string required: - target_account_nkey_public type: object StreamShareListResponse: example: items: - target_account_nkey_public: target_account_nkey_public - target_account_nkey_public: target_account_nkey_public properties: items: items: $ref: '#/components/schemas/StreamShareViewResponse' type: array required: - items type: object StreamShareViewResponse: example: target_account_nkey_public: target_account_nkey_public properties: target_account_nkey_public: type: string required: - target_account_nkey_public type: object StreamSource: description: StreamSource dictates how streams can source from other streams. example: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest properties: consumer: $ref: '#/components/schemas/StreamSource_consumer' external: $ref: '#/components/schemas/StreamSource_external' filter_subject: type: string name: type: string opt_start_seq: maximum: 18446744073709551615 minimum: 0 type: integer opt_start_time: nullable: true type: string subject_transforms: items: $ref: '#/components/schemas/SubjectTransformConfig' type: array required: - name type: object StreamSourceInfo: description: StreamSourceInfo shows information about an upstream stream source. example: external: null lag: 2147483647 name: name active: 0 error: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest properties: active: format: int64 type: integer error: $ref: '#/components/schemas/StreamSourceInfo_error' external: $ref: '#/components/schemas/StreamSource_external' filter_subject: type: string lag: maximum: 18446744073709551615 minimum: 0 type: integer name: type: string subject_transforms: items: $ref: '#/components/schemas/SubjectTransformConfig' type: array required: - active - lag - name type: object StreamState: properties: bytes: maximum: 18446744073709551615 minimum: 0 type: integer consumer_count: type: integer deleted: items: maximum: 18446744073709551615 minimum: 0 type: integer type: array first_seq: maximum: 18446744073709551615 minimum: 0 type: integer first_ts: format: date-time type: string last_seq: maximum: 18446744073709551615 minimum: 0 type: integer last_ts: format: date-time type: string lost: $ref: '#/components/schemas/StreamState_lost' messages: maximum: 18446744073709551615 minimum: 0 type: integer num_deleted: type: integer num_subjects: type: integer subjects: additionalProperties: maximum: 18446744073709551615 minimum: 0 type: integer type: object required: - bytes - consumer_count - first_seq - first_ts - last_seq - last_ts - messages type: object SubDetail: description: SubDetail is for verbose information for subscriptions. properties: account: type: string cid: maximum: 18446744073709551615 minimum: 0 type: integer max: format: int64 type: integer msgs: format: int64 type: integer qgroup: type: string sid: type: string subject: type: string required: - cid - msgs - sid - subject type: object SubjectExportChartTypes: enum: - ServiceLatency - SystemLatency - TotalLatency - Throughput - ErrorRate type: string SubjectExportCreateRequest: example: jwt_settings: revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 metrics_sampling_percentage: 0 metrics_enabled: true properties: jwt_settings: $ref: '#/components/schemas/Export' metrics_enabled: type: boolean metrics_sampling_percentage: format: int64 type: integer required: - jwt_settings - metrics_enabled - metrics_sampling_percentage type: object SubjectExportListResponse: example: items: - share_sk_public: share_sk_public stream_export_id: stream_export_id created: 2000-01-23T04:56:07.000+00:00 subject: subject jwt_settings: revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 is_public: true name: name id: id metrics_sampling_percentage: 0 metrics_enabled: true account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true - share_sk_public: share_sk_public stream_export_id: stream_export_id created: 2000-01-23T04:56:07.000+00:00 subject: subject jwt_settings: revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 is_public: true name: name id: id metrics_sampling_percentage: 0 metrics_enabled: true account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true properties: items: items: $ref: '#/components/schemas/SubjectExportViewResponse' type: array required: - items type: object SubjectExportSharedListResponse: example: items: - jwt_settings: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token export_id: export_id - jwt_settings: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token export_id: export_id properties: items: items: $ref: '#/components/schemas/SubjectExportSharedViewResponse' type: array required: - items type: object SubjectExportSharedViewResponse: example: jwt_settings: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token export_id: export_id properties: export_id: type: string jwt_settings: $ref: '#/components/schemas/Import' required: - export_id - jwt_settings type: object SubjectExportUpdateRequest: example: jwt_settings: revocations: "{}" account_token_position: 0 subject: subject name: name description: description response_type: null token_req: true type: null service_latency: null advertise: true info_url: info_url response_threshold: 2147483647 metrics_sampling_percentage: 1 metrics_enabled: true properties: jwt_settings: $ref: '#/components/schemas/ExportPatch' metrics_enabled: type: boolean metrics_sampling_percentage: format: int64 type: integer type: object SubjectExportViewResponse: description: |- / Subject Exports / example: share_sk_public: share_sk_public stream_export_id: stream_export_id created: 2000-01-23T04:56:07.000+00:00 subject: subject jwt_settings: revocations: key: 5 account_token_position: 0 subject: subject name: name response_type: null token_req: true type: null service_latency: sampling: 23 results: results advertise: true response_threshold: 5 is_public: true name: name id: id metrics_sampling_percentage: 0 metrics_enabled: true account: user_jwt: user_jwt auth_type: null user_cred: user_cred account_public_key: account_public_key name: name user_jwt_expires_in_secs: 0 id: id is_platform_account: true is_scp_account: true is_system_account: true properties: account: $ref: '#/components/schemas/AccountInfo' created: format: date-time type: string id: type: string is_public: type: boolean jwt_settings: $ref: '#/components/schemas/Export' metrics_enabled: type: boolean metrics_sampling_percentage: format: int64 type: integer name: nullable: true type: string share_sk_public: nullable: true type: string stream_export_id: nullable: true type: string subject: type: string required: - account - created - id - is_public - jwt_settings - metrics_enabled - metrics_sampling_percentage - name - share_sk_public - stream_export_id - subject type: object SubjectImportCreateRequest: example: jwt_settings: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token properties: jwt_settings: $ref: '#/components/schemas/Import' required: - jwt_settings type: object SubjectImportListResponse: example: items: - remote_account_nkey_public: remote_account_nkey_public remote_subject: remote_subject created: 2000-01-23T04:56:07.000+00:00 jwt_settings: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token name: name id: id - remote_account_nkey_public: remote_account_nkey_public remote_subject: remote_subject created: 2000-01-23T04:56:07.000+00:00 jwt_settings: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token name: name id: id properties: items: items: $ref: '#/components/schemas/SubjectImportViewResponse' type: array required: - items type: object SubjectImportUpdateRequest: example: jwt_settings: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token properties: jwt_settings: $ref: '#/components/schemas/ImportPatch' type: object SubjectImportViewResponse: description: |- / Subject Imports / example: remote_account_nkey_public: remote_account_nkey_public remote_subject: remote_subject created: 2000-01-23T04:56:07.000+00:00 jwt_settings: local_subject: local_subject subject: subject name: name share: true to: to type: null account: account token: token name: name id: id properties: created: format: date-time type: string id: type: string jwt_settings: $ref: '#/components/schemas/Import' name: type: string remote_account_nkey_public: type: string remote_subject: type: string required: - created - id - jwt_settings - name - remote_account_nkey_public - remote_subject type: object SubjectShareCreateRequest: example: target_account_nkey_public: target_account_nkey_public properties: target_account_nkey_public: type: string required: - target_account_nkey_public type: object SubjectShareListResponse: example: items: - subject_export_id: subject_export_id created: 2000-01-23T04:56:07.000+00:00 jwt: jwt id: id target_account_nkey_public: target_account_nkey_public jwt_claims: nats: kind: null subject: subject issuer_account: issuer_account - subject_export_id: subject_export_id created: 2000-01-23T04:56:07.000+00:00 jwt: jwt id: id target_account_nkey_public: target_account_nkey_public jwt_claims: nats: kind: null subject: subject issuer_account: issuer_account properties: items: items: $ref: '#/components/schemas/SubjectShareViewResponse' type: array required: - items type: object SubjectShareViewResponse: description: |- / Subject Shares / example: subject_export_id: subject_export_id created: 2000-01-23T04:56:07.000+00:00 jwt: jwt id: id target_account_nkey_public: target_account_nkey_public jwt_claims: nats: kind: null subject: subject issuer_account: issuer_account properties: created: format: date-time type: string id: type: string jwt: type: string jwt_claims: $ref: '#/components/schemas/ActivationClaims' subject_export_id: type: string target_account_nkey_public: type: string required: - created - id - jwt - jwt_claims - subject_export_id - target_account_nkey_public type: object SubjectTransformConfig: description: |- SubjectTransformConfig is for applying a subject transform (to matching messages) before doing anything else when a new message is received example: src: src dest: dest properties: dest: type: string src: type: string required: - dest - src type: object SystemAccountImportRequest: example: seed: seed jwt: jwt signing_keys: - signing_keys - signing_keys properties: jwt: type: string seed: type: string signing_keys: items: type: string type: array required: - jwt - seed type: object SystemAssignment: example: role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name properties: account_assignments: items: $ref: '#/components/schemas/AccountAssignment' type: array role: type: string system_id: type: string system_name: type: string required: - role - system_id type: object SystemConnectionType: default: Agent enum: - Agent - Direct type: string SystemConnectionsListResponse: example: items: - total: 5 offset: 1 now: 2000-01-23T04:56:07.000+00:00 limit: 0 num_connections: 6 server_id: server_id connections: - null - null - total: 5 offset: 1 now: 2000-01-23T04:56:07.000+00:00 limit: 0 num_connections: 6 server_id: server_id connections: - null - null properties: items: items: $ref: '#/components/schemas/Connz' type: array required: - items type: object SystemCreateRequest: example: jetstream_enabled: true connection_type: null managed_by: null name: name jetstream_domain: jetstream_domain url: url direct_connection_opts: tls_client_key: tls_client_key tls_mode: null override_urls: override_urls tls_client_cert: tls_client_cert tls_insecure_skip_verify: false tls_ca_certs: tls_ca_certs properties: connection_type: $ref: '#/components/schemas/SystemConnectionType' direct_connection_opts: $ref: '#/components/schemas/SystemDirectConnectionOpts' jetstream_domain: type: string jetstream_enabled: default: true type: boolean managed_by: $ref: '#/components/schemas/SystemManagedBy' name: type: string url: type: string required: - name - url type: object SystemDirectConnectionOpts: example: tls_client_key: tls_client_key tls_mode: null override_urls: override_urls tls_client_cert: tls_client_cert tls_insecure_skip_verify: false tls_ca_certs: tls_ca_certs properties: override_urls: type: string tls_ca_certs: type: string tls_client_cert: type: string tls_client_key: type: string tls_insecure_skip_verify: default: false type: boolean tls_mode: $ref: '#/components/schemas/TLSMode' required: - tls_insecure_skip_verify - tls_mode type: object SystemDirectConnectionOptsPatch: properties: override_urls: type: string tls_ca_certs: type: string tls_client_cert: type: string tls_client_key: type: string tls_insecure_skip_verify: default: false type: boolean tls_mode: $ref: '#/components/schemas/TLSMode' type: object SystemExportResponse: example: system_account: seed: seed jwt: jwt name: name signing_key_groups: - name: name signing_keys: - seed: seed id: id - seed: seed id: id - name: name signing_keys: - seed: seed id: id - seed: seed id: id id: id users: - seed: seed jwt: jwt name: name id: id - seed: seed jwt: jwt name: name id: id name: name accounts: - seed: seed jwt: jwt name: name signing_key_groups: - name: name signing_keys: - seed: seed id: id - seed: seed id: id - name: name signing_keys: - seed: seed id: id - seed: seed id: id id: id users: - seed: seed jwt: jwt name: name id: id - seed: seed jwt: jwt name: name id: id - seed: seed jwt: jwt name: name signing_key_groups: - name: name signing_keys: - seed: seed id: id - seed: seed id: id - name: name signing_keys: - seed: seed id: id - seed: seed id: id id: id users: - seed: seed jwt: jwt name: name id: id - seed: seed jwt: jwt name: name id: id operator: seed: seed jwt: jwt name: name signing_keys: - seed: seed id: id - seed: seed id: id id: id properties: accounts: items: $ref: '#/components/schemas/AccountExportResponse' type: array name: type: string operator: $ref: '#/components/schemas/OperatorExport' system_account: $ref: '#/components/schemas/AccountExportResponse' required: - accounts - name - operator - system_account type: object SystemImportRequest: example: jetstream_enabled: true system_jwt: system_jwt managed_by: null operator_jwt: operator_jwt name: name system_key: system_key sys_secret: sys_secret sys_auth_type: null jetstream_domain: jetstream_domain operator_key: operator_key sys_cred: sys_cred properties: jetstream_domain: type: string jetstream_enabled: default: true type: boolean managed_by: $ref: '#/components/schemas/SystemManagedBy' name: type: string operator_jwt: type: string operator_key: type: string sys_auth_type: $ref: '#/components/schemas/AccountAuthType' sys_cred: type: string sys_secret: type: string system_jwt: type: string system_key: type: string type: object SystemInfo: example: jetstream_enabled: true http_gateway_url: http_gateway_url is_tenant: true connection_type: null managed_by: null config_mode: true server_urls: server_urls user_jwt_expires_in_secs: 7 jetstream_tiers: - jetstream_tiers - jetstream_tiers name: name id: id state: null jetstream_domain: jetstream_domain properties: config_mode: type: boolean connection_type: $ref: '#/components/schemas/SystemConnectionType' http_gateway_url: type: string id: type: string is_tenant: type: boolean jetstream_domain: type: string jetstream_enabled: type: boolean jetstream_tiers: items: type: string type: array managed_by: $ref: '#/components/schemas/SystemManagedBy' name: type: string server_urls: type: string state: $ref: '#/components/schemas/SystemState' user_jwt_expires_in_secs: format: int64 type: integer required: - config_mode - connection_type - id - is_tenant - jetstream_enabled - name - state - user_jwt_expires_in_secs type: object SystemLimitsResponse: example: total: data: total_sent: 2 gateway_sent: 5 route_received: 7 route_sent: 9 client_received: 0 client_sent: 6 leaf_sent: 2 leaf_received: 5 gateway_received: 1 total_received: 3 workloads: container: 1 function: 1 num_connectors: 7 num_accounts: 4 resource_limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 available: data: total_sent: 2 gateway_sent: 5 route_received: 7 route_sent: 9 client_received: 0 client_sent: 6 leaf_sent: 2 leaf_received: 5 gateway_received: 1 total_received: 3 workloads: container: 1 function: 1 num_connectors: 7 num_accounts: 4 resource_limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 allocated: data: total_sent: 2 gateway_sent: 5 route_received: 7 route_sent: 9 client_received: 0 client_sent: 6 leaf_sent: 2 leaf_received: 5 gateway_received: 1 total_received: 3 workloads: container: 1 function: 1 num_connectors: 7 num_accounts: 4 resource_limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 properties: allocated: $ref: '#/components/schemas/TenantLimits' available: $ref: '#/components/schemas/TenantLimits' total: $ref: '#/components/schemas/TenantLimits' required: - allocated - available - total type: object SystemListResponse: example: items: - is_tenant: true system_account_jwt: system_account_jwt managed_by: null config_mode: true has_managed_operator: true has_managed_system_account: true jetstream_tiers: - jetstream_tiers - jetstream_tiers log_forwarding_opts: subject_prefix: subject_prefix account_id: account_id enabled: true levels: - null - null audit_only: true id: id nats_alerting_config: receivers: - null - null subject: subject account: account state: null jetstream_enabled: true connection_type: null limited: true created: 2000-01-23T04:56:07.000+00:00 operator_jwt: operator_jwt max_nodes: 0 user_jwt_expires_in_secs: 6 operator_claims: nats: system_account: system_account signing_keys: - signing_keys - signing_keys strict_signing_key_usage: true operator_service_urls: - operator_service_urls - operator_service_urls assert_server_version: assert_server_version account_server_url: account_server_url team: name: name id: id direct_connection_opts: tls_client_key: tls_client_key tls_mode: null override_urls: override_urls tls_client_cert: tls_client_cert tls_insecure_skip_verify: false tls_ca_certs: tls_ca_certs host_system_id: host_system_id updates_available: key: current: current latest_minor: latest_minor latest: latest latest_patch: latest_patch platform_components: components: - id: id type: null config: null enabled: true - id: id type: null config: null enabled: true system_id: system_id name: name jetstream_domain: jetstream_domain - is_tenant: true system_account_jwt: system_account_jwt managed_by: null config_mode: true has_managed_operator: true has_managed_system_account: true jetstream_tiers: - jetstream_tiers - jetstream_tiers log_forwarding_opts: subject_prefix: subject_prefix account_id: account_id enabled: true levels: - null - null audit_only: true id: id nats_alerting_config: receivers: - null - null subject: subject account: account state: null jetstream_enabled: true connection_type: null limited: true created: 2000-01-23T04:56:07.000+00:00 operator_jwt: operator_jwt max_nodes: 0 user_jwt_expires_in_secs: 6 operator_claims: nats: system_account: system_account signing_keys: - signing_keys - signing_keys strict_signing_key_usage: true operator_service_urls: - operator_service_urls - operator_service_urls assert_server_version: assert_server_version account_server_url: account_server_url team: name: name id: id direct_connection_opts: tls_client_key: tls_client_key tls_mode: null override_urls: override_urls tls_client_cert: tls_client_cert tls_insecure_skip_verify: false tls_ca_certs: tls_ca_certs host_system_id: host_system_id updates_available: key: current: current latest_minor: latest_minor latest: latest latest_patch: latest_patch platform_components: components: - id: id type: null config: null enabled: true - id: id type: null config: null enabled: true system_id: system_id name: name jetstream_domain: jetstream_domain properties: items: items: $ref: '#/components/schemas/SystemViewResponse' type: array required: - items type: object SystemLogForwardingOpts: example: subject_prefix: subject_prefix account_id: account_id enabled: true levels: - null - null audit_only: true properties: account_id: type: string audit_only: type: boolean enabled: type: boolean levels: items: $ref: '#/components/schemas/SystemLogLevel' type: array subject_prefix: type: string required: - account_id - audit_only - enabled - levels - subject_prefix type: object SystemLogForwardingOptsPatch: properties: account_id: type: string audit_only: type: boolean enabled: type: boolean levels: items: $ref: '#/components/schemas/SystemLogLevel' type: array subject_prefix: type: string type: object SystemLogLevel: enum: - panic - fatal - error - warn - info - debug - trace type: string SystemManagedBy: enum: - byon - sdkube type: string SystemState: enum: - Provisioning - Connected - Disconnected type: string SystemUpdateRequest: example: jetstream_enabled: true connection_type: null log_forwarding_opts: null operator_jwt: operator_jwt name: name nats_alerting_config: null jetstream_domain: jetstream_domain url: url direct_connection_opts: null properties: connection_type: $ref: '#/components/schemas/SystemConnectionType' direct_connection_opts: $ref: '#/components/schemas/SystemUpdateRequest_direct_connection_opts' jetstream_domain: nullable: true type: string jetstream_enabled: type: boolean log_forwarding_opts: $ref: '#/components/schemas/SystemUpdateRequest_log_forwarding_opts' name: type: string nats_alerting_config: $ref: '#/components/schemas/SystemUpdateRequest_nats_alerting_config' operator_jwt: type: string url: type: string type: object SystemUserImportRequest: example: credential: credential seed: seed jwt: jwt properties: credential: type: string jwt: type: string seed: type: string type: object SystemViewResponse: example: is_tenant: true system_account_jwt: system_account_jwt managed_by: null config_mode: true has_managed_operator: true has_managed_system_account: true jetstream_tiers: - jetstream_tiers - jetstream_tiers log_forwarding_opts: subject_prefix: subject_prefix account_id: account_id enabled: true levels: - null - null audit_only: true id: id nats_alerting_config: receivers: - null - null subject: subject account: account state: null jetstream_enabled: true connection_type: null limited: true created: 2000-01-23T04:56:07.000+00:00 operator_jwt: operator_jwt max_nodes: 0 user_jwt_expires_in_secs: 6 operator_claims: nats: system_account: system_account signing_keys: - signing_keys - signing_keys strict_signing_key_usage: true operator_service_urls: - operator_service_urls - operator_service_urls assert_server_version: assert_server_version account_server_url: account_server_url team: name: name id: id direct_connection_opts: tls_client_key: tls_client_key tls_mode: null override_urls: override_urls tls_client_cert: tls_client_cert tls_insecure_skip_verify: false tls_ca_certs: tls_ca_certs host_system_id: host_system_id updates_available: key: current: current latest_minor: latest_minor latest: latest latest_patch: latest_patch platform_components: components: - id: id type: null config: null enabled: true - id: id type: null config: null enabled: true system_id: system_id name: name jetstream_domain: jetstream_domain properties: config_mode: type: boolean connection_type: $ref: '#/components/schemas/SystemConnectionType' created: format: date-time type: string direct_connection_opts: $ref: '#/components/schemas/SystemDirectConnectionOpts' has_managed_operator: type: boolean has_managed_system_account: type: boolean host_system_id: type: string id: type: string is_tenant: type: boolean jetstream_domain: type: string jetstream_enabled: type: boolean jetstream_tiers: items: type: string type: array limited: type: boolean log_forwarding_opts: $ref: '#/components/schemas/SystemLogForwardingOpts' managed_by: $ref: '#/components/schemas/SystemManagedBy' max_nodes: format: int32 type: integer name: type: string nats_alerting_config: $ref: '#/components/schemas/NatsAlertingConfig' operator_claims: $ref: '#/components/schemas/OperatorClaims' operator_jwt: type: string platform_components: $ref: '#/components/schemas/PlatformComponentsViewResponse' state: $ref: '#/components/schemas/SystemState' system_account_jwt: type: string team: $ref: '#/components/schemas/TeamInfo' updates_available: additionalProperties: $ref: '#/components/schemas/Update' type: object user_jwt_expires_in_secs: format: int64 type: integer required: - config_mode - connection_type - created - has_managed_operator - has_managed_system_account - id - is_tenant - jetstream_enabled - limited - name - state - team - updates_available - user_jwt_expires_in_secs type: object TLSMode: enum: - Auto - Require - Implicit type: string TLSPeerCert: description: TLSPeerCert contains basic information about a TLS peer certificate properties: cert_sha256: type: string spki_sha256: type: string subject: type: string type: object TeamAppUserAssociation: example: role_id: role_id resource_type: null resource_id: resource_id properties: resource_id: type: string resource_type: $ref: '#/components/schemas/TeamAppUserResourceType' role_id: type: string required: - resource_id - resource_type - role_id type: object TeamAppUserInfo: example: role_name: role_name role_id: role_id pending_invitation: true id: id properties: id: type: string pending_invitation: type: boolean role_id: type: string role_name: type: string required: - id - pending_invitation - role_id - role_name type: object TeamAppUserListResponse: example: items: - role_name: role_name app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 pending_invitation: true id: id team: name: name id: id - role_name: role_name app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 pending_invitation: true id: id team: name: name id: id properties: items: items: $ref: '#/components/schemas/TeamAppUserViewResponse' type: array required: - items type: object TeamAppUserResourceType: enum: - System - Account - NatsUser type: string TeamAppUserViewResponse: example: role_name: role_name app_user: identifier: identifier name: name id: id type: null role_id: role_id created: 2000-01-23T04:56:07.000+00:00 pending_invitation: true id: id team: name: name id: id properties: app_user: $ref: '#/components/schemas/AppUserInfo' created: format: date-time type: string id: type: string pending_invitation: type: boolean role_id: type: string role_name: type: string team: $ref: '#/components/schemas/TeamInfo' required: - app_user - created - id - pending_invitation - role_id - role_name - team type: object TeamAssignment: example: role: role system_assignments: - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name - role: role system_id: system_id system_name: system_name account_assignments: - account_id: account_id role: role account_name: account_name - account_id: account_id role: role account_name: account_name team_id: team_id team_name: team_name properties: role: type: string system_assignments: items: $ref: '#/components/schemas/SystemAssignment' type: array team_id: type: string team_name: type: string required: - role - team_id type: object TeamCreateRequest: example: name: name properties: name: type: string required: - name type: object TeamInfo: example: name: name id: id properties: id: type: string name: type: string required: - id - name type: object TeamLimits: example: num_sdkube: null num_systems: 0 num_users: 6 disable_prometheus_federation: true properties: disable_prometheus_federation: type: boolean num_sdkube: $ref: '#/components/schemas/TeamLimits_num_sdkube' num_systems: nullable: true type: integer num_users: nullable: true type: integer required: - disable_prometheus_federation - num_sdkube - num_systems - num_users type: object TeamLimitsResponse: example: total: num_sdkube: null num_systems: 0 num_users: 6 disable_prometheus_federation: true available: num_sdkube: null num_systems: 0 num_users: 6 disable_prometheus_federation: true allocated: num_sdkube: null num_systems: 0 num_users: 6 disable_prometheus_federation: true properties: allocated: $ref: '#/components/schemas/TeamLimits' available: $ref: '#/components/schemas/TeamLimits' total: $ref: '#/components/schemas/TeamLimits' required: - allocated - available - total type: object TeamListResponse: example: items: - created: 2000-01-23T04:56:07.000+00:00 name: name id: id limits: num_sdkube: null num_systems: 0 num_users: 6 disable_prometheus_federation: true - created: 2000-01-23T04:56:07.000+00:00 name: name id: id limits: num_sdkube: null num_systems: 0 num_users: 6 disable_prometheus_federation: true properties: items: items: $ref: '#/components/schemas/TeamViewResponse' type: array required: - items type: object TeamUpdateRequest: example: name: name properties: name: type: string type: object TeamViewResponse: example: created: 2000-01-23T04:56:07.000+00:00 name: name id: id limits: num_sdkube: null num_systems: 0 num_users: 6 disable_prometheus_federation: true properties: created: format: date-time type: string id: type: string limits: $ref: '#/components/schemas/TeamLimits' name: type: string required: - created - id - name type: object TenantLimits: example: data: total_sent: 2 gateway_sent: 5 route_received: 7 route_sent: 9 client_received: 0 client_sent: 6 leaf_sent: 2 leaf_received: 5 gateway_received: 1 total_received: 3 workloads: container: 1 function: 1 num_connectors: 7 num_accounts: 4 resource_limits: tiered_limits: key: max_ack_pending: 2 mem_max_stream_bytes: 4 disk_max_stream_bytes: 9 disk_storage: 3 max_bytes_required: true streams: 1 mem_storage: 7 consumer: 7 properties: data: $ref: '#/components/schemas/DataLimits' num_accounts: nullable: true type: integer num_connectors: nullable: true type: integer resource_limits: $ref: '#/components/schemas/OperatorLimits' workloads: $ref: '#/components/schemas/WorkloadLimits' required: - num_accounts - num_connectors - resource_limits - workloads type: object TimeRange: description: TimeRange is used to represent a start and end time properties: end: type: string start: type: string type: object UpdatableKVBucketConfig: example: metadata: key: metadata mirror: opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest sources: - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest - opt_start_time: opt_start_time external: null opt_start_seq: 2147483647 name: name consumer: null filter_subject: filter_subject subject_transforms: - src: src dest: dest - src: src dest: dest max_value_size: 5 description: description history: 20 max_bytes: 5 max_age: 1 republish: src: src headers_only: true dest: dest num_replicas: 2 limit_marker_ttl: 6 placement: cluster: cluster tags: - tags - tags compression: true properties: compression: type: boolean description: type: string history: maximum: 255 minimum: 0 type: integer limit_marker_ttl: format: int64 type: integer max_age: format: int64 type: integer max_bytes: format: int64 type: integer max_value_size: format: int32 type: integer metadata: additionalProperties: type: string type: object mirror: $ref: '#/components/schemas/StreamSource' num_replicas: type: integer placement: $ref: '#/components/schemas/Placement' republish: $ref: '#/components/schemas/RePublish' sources: items: $ref: '#/components/schemas/StreamSource' type: array type: object UpdatableObjectBucketConfig: description: ObjectStoreConfig is the config for the object store. example: max_age: 0 metadata: key: metadata num_replicas: 1 description: description max_bytes: 6 placement: cluster: cluster tags: - tags - tags compression: true properties: compression: description: Enable underlying stream compression. type: boolean description: type: string max_age: format: int64 type: integer max_bytes: format: int64 type: integer metadata: additionalProperties: type: string description: Bucket-specific metadata type: object num_replicas: type: integer placement: $ref: '#/components/schemas/Placement' type: object Update: example: current: current latest_minor: latest_minor latest: latest latest_patch: latest_patch properties: current: type: string latest: type: string latest_minor: type: string latest_patch: type: string required: - current - latest - latest_minor - latest_patch type: object UpdateRequest: properties: definition: description: The schema definition (required). nullable: true type: string description: description: Description of the schema (optional). nullable: true type: string format: type: string metadata: additionalProperties: type: string description: Metadata is a map of key-value pairs (optional). nullable: true type: object name: description: "Part of the public API, but derived from subject, not from\ \ the payload." type: string revision: type: integer version: type: integer type: object UpdateResponse: properties: revision: type: integer version: type: integer required: - revision - version type: object User: allOf: - $ref: '#/components/schemas/GenericFields' - $ref: '#/components/schemas/UserPermissionLimits' description: User defines the user specific data in a user JWT example: issuer_account: issuer_account properties: issuer_account: description: |- IssuerAccount stores the public key for the account the issuer represents. When set, the claim was issued by a signing key. type: string type: object UserClaims: allOf: - $ref: '#/components/schemas/ClaimsData' description: UserClaims defines a user JWT example: nats: issuer_account: issuer_account properties: nats: $ref: '#/components/schemas/User' type: object UserExport: example: seed: seed jwt: jwt name: name id: id properties: id: type: string jwt: type: string name: type: string seed: type: string required: - id - jwt - name - seed type: object UserLimits: description: Src is a comma separated list of CIDR specifications properties: src: items: type: string type: array times: items: $ref: '#/components/schemas/TimeRange' type: array times_location: type: string type: object UserPermissionLimits: allOf: - $ref: '#/components/schemas/Permissions' - $ref: '#/components/schemas/UserLimits' - $ref: '#/components/schemas/NatsLimits' example: bearer_token: true allowed_connection_types: - allowed_connection_types - allowed_connection_types properties: allowed_connection_types: items: type: string type: array bearer_token: type: boolean type: object UserPermissionLimitsPatch: example: sub: null bearer_token: true times: - start: start end: end - start: start end: end times_location: times_location data: 0 payload: 6 resp: null src: - src - src subs: 1 allowed_connection_types: - allowed_connection_types - allowed_connection_types pub: null properties: allowed_connection_types: items: type: string nullable: true type: array bearer_token: type: boolean data: format: int64 type: integer payload: format: int64 type: integer pub: $ref: '#/components/schemas/NatsUserJwtSettingsPatch_pub' resp: $ref: '#/components/schemas/NatsUserJwtSettingsPatch_resp' src: items: type: string nullable: true type: array sub: $ref: '#/components/schemas/NatsUserJwtSettingsPatch_pub' subs: format: int64 type: integer times: items: $ref: '#/components/schemas/NatsUserJwtSettingsPatch_times_inner' nullable: true type: array times_location: nullable: true type: string type: object ValidateRequest: properties: data: description: Data to validate. format: binary type: string subject: description: Subject of the schema (optional). type: string required: - data type: object ValidateResponse: type: object VersionResponse: example: date: date commit: commit version: version properties: commit: type: string date: type: string version: type: string required: - commit - date - version type: object WeightedMapping: description: Mapping for publishes example: cluster: cluster subject: subject weight: 26 properties: cluster: type: string subject: type: string weight: maximum: 255 minimum: 0 type: integer required: - subject type: object WorkloadAuctionRequest: properties: agent_type: type: string tags: additionalProperties: type: string type: object required: - agent_type - tags type: object WorkloadAuctionResponse: properties: bidder_id: type: string start_request_schema: type: string supported_lifecycles: items: type: string type: array xkey: type: string required: - bidder_id - start_request_schema - supported_lifecycles - xkey type: object WorkloadField: properties: constraints: items: $ref: '#/components/schemas/WorkloadFieldConstraint' type: array default: {} description: type: string fields: items: $ref: '#/components/schemas/WorkloadField' type: array kind: $ref: '#/components/schemas/WorkloadFieldKind' name: type: string optional: type: boolean type: $ref: '#/components/schemas/WorkloadFieldType' required: - description - kind - name - type type: object WorkloadFieldConstraint: properties: enum: items: type: string type: array preset: type: string range: $ref: '#/components/schemas/WorkloadFieldContstraintRange' regex: type: string unique_items: type: boolean type: object WorkloadFieldContstraintRange: properties: gt: format: double type: number gte: format: double type: number lt: format: double type: number lte: format: double type: number type: object WorkloadFieldKind: enum: - scalar - map - list type: string WorkloadFieldType: enum: - bool - int - object - string type: string WorkloadLifecycle: enum: - function - job - service type: string WorkloadLimits: example: container: 1 function: 1 properties: container: type: integer function: type: integer required: - container - function type: object WorkloadLimitsResponse: example: connectors: current_count: 0 limit: 6 workloads: container: current_count: 0 limit: 6 function: current_count: 0 limit: 6 properties: connectors: $ref: '#/components/schemas/WorkloadStateLimit' workloads: $ref: '#/components/schemas/WorkloadStateLimits' required: - connectors - workloads type: object WorkloadStartRequest: properties: auction: $ref: '#/components/schemas/WorkloadAuctionRequest' description: type: string name: type: string run_request: type: string workload_lifecycle: type: string workload_type: type: string required: - auction - description - name - run_request - workload_lifecycle - workload_type type: object WorkloadStartResponse: properties: id: type: string name: type: string required: - id - name type: object WorkloadState: enum: - error - running - starting - stopping - stopped - warm type: string WorkloadStateLimit: example: current_count: 0 limit: 6 properties: current_count: format: int64 type: integer limit: format: int64 type: integer required: - current_count - limit type: object WorkloadStateLimits: example: container: current_count: 0 limit: 6 function: current_count: 0 limit: 6 properties: container: $ref: '#/components/schemas/WorkloadStateLimit' function: $ref: '#/components/schemas/WorkloadStateLimit' required: - container - function type: object WorkloadStopResponse: properties: id: type: string message: type: string stopped: type: boolean required: - id - message - stopped type: object WorkloadSummary: properties: description: type: string id: type: string metadata: type: object name: type: string namespace: type: string reference: type: string run_request: type: string runtime: type: string start_time: type: string tags: additionalProperties: type: string type: object workload_lifecycle: $ref: '#/components/schemas/WorkloadLifecycle' workload_state: $ref: '#/components/schemas/WorkloadState' workload_type: type: string required: - description - id - name - run_request - runtime - start_time - tags - workload_lifecycle - workload_state - workload_type type: object WorkloadTagsResponse: example: tags: key: tags properties: tags: additionalProperties: type: string type: object required: - tags type: object WorkloadsListResponse: properties: items: items: $ref: '#/components/schemas/WorkloadSummary' type: array required: - items type: object WorkloadsPlatformComponentConfig: properties: account: type: string nexus_name: type: string required: - account - nexus_name type: object jwtAccountClaims: $ref: '#/components/schemas/AccountClaims' jwtUserClaims: $ref: '#/components/schemas/UserClaims' AccountJWTSettingsPatch_authorization: allOf: - $ref: '#/components/schemas/ExternalAuthorizationPatch' nullable: true type: object AccountJWTSettingsPatch_limits: allOf: - $ref: '#/components/schemas/OperatorLimitsPatch' nullable: true type: object AccountOverviewResponse_metrics: example: JetStreamR1StorageUsed: 1.4658129805029452 BytesReceived: 0.8008281904610115 NumLeafNodes: 2.3021358869347655 NumConnections: 5.637376656633329 NumMessagesSent: 9.301444243932576 BytesSent: 6.027456183070403 JetStreamR3StorageUsed: 5.962133916683182 NumMessagesReceived: 7.061401241503109 properties: BytesReceived: format: double type: number BytesSent: format: double type: number JetStreamR1StorageUsed: format: double type: number JetStreamR3StorageUsed: format: double type: number NumConnections: format: double type: number NumLeafNodes: format: double type: number NumMessagesReceived: format: double type: number NumMessagesSent: format: double type: number required: - BytesReceived - BytesSent - JetStreamR1StorageUsed - JetStreamR3StorageUsed - NumConnections - NumLeafNodes - NumMessagesReceived - NumMessagesSent type: object ClusterInfo_replicas_inner: allOf: - $ref: '#/components/schemas/PeerInfo' nullable: true type: object ConnInfo_tls_peer_certs_inner: allOf: - $ref: '#/components/schemas/TLSPeerCert' nullable: true type: object Connz_connections_inner: allOf: - $ref: '#/components/schemas/ConnInfo' nullable: true type: object ConsumerInfo_cluster: allOf: - $ref: '#/components/schemas/ClusterInfo' nullable: true type: object ExportPatch_service_latency: allOf: - $ref: '#/components/schemas/ServiceLatencyPatch' nullable: true type: object GetResponse_schema: allOf: - $ref: '#/components/schemas/Schema' nullable: true type: object JetStreamTieredLimitsPatch_value: allOf: - $ref: '#/components/schemas/JetStreamLimits' nullable: true type: object JetStreamVarz_config: allOf: - $ref: '#/components/schemas/JetStreamConfig' nullable: true type: object JetStreamVarz_meta: allOf: - $ref: '#/components/schemas/MetaClusterInfo' nullable: true type: object JetStreamVarz_stats: allOf: - $ref: '#/components/schemas/JetStreamStats' nullable: true type: object Leafz_leafs_inner: allOf: - $ref: '#/components/schemas/LeafInfo' nullable: true type: object NatsAlertingConfigPatch_receivers_inner_config: properties: channel: type: string token: type: string required: - channel - token type: object NatsAlertingConfigPatch_receivers_inner: properties: config: $ref: '#/components/schemas/NatsAlertingConfigPatch_receivers_inner_config' type: enum: - slack type: string required: - config - type type: object NatsUserJwtSettingsPatch_pub: allOf: - $ref: '#/components/schemas/PermissionPatch' nullable: true type: object NatsUserJwtSettingsPatch_resp: allOf: - $ref: '#/components/schemas/ResponsePermissionPatch' nullable: true type: object NatsUserJwtSettingsPatch_times_inner: example: start: start end: end properties: end: type: string start: type: string type: object ServerStats_gateways_inner: allOf: - $ref: '#/components/schemas/GatewayStat' nullable: true type: object ServerStats_jetstream: allOf: - $ref: '#/components/schemas/JetStreamVarz' nullable: true type: object ServerStats_routes_inner: allOf: - $ref: '#/components/schemas/RouteStat' nullable: true type: object ServiceAccountUpdateRequest_resources_value: allOf: - $ref: '#/components/schemas/AppUserAssignRequest' nullable: true type: object SigningKeys_inner: oneOf: - type: string - $ref: '#/components/schemas/SigningKeyScope' StreamSource_consumer: allOf: - $ref: '#/components/schemas/StreamConsumerSource' nullable: true type: object StreamSource_external: allOf: - $ref: '#/components/schemas/ExternalStream' nullable: true type: object StreamSourceInfo_error: allOf: - $ref: '#/components/schemas/JSApiError' nullable: true type: object StreamState_lost: allOf: - $ref: '#/components/schemas/LostStreamData' nullable: true type: object SystemUpdateRequest_direct_connection_opts: allOf: - $ref: '#/components/schemas/SystemDirectConnectionOptsPatch' nullable: true type: object SystemUpdateRequest_log_forwarding_opts: allOf: - $ref: '#/components/schemas/SystemLogForwardingOptsPatch' nullable: true type: object SystemUpdateRequest_nats_alerting_config: allOf: - $ref: '#/components/schemas/NatsAlertingConfigPatch' nullable: true type: object TeamLimits_num_sdkube: allOf: - $ref: '#/components/schemas/SDKubeLimit' nullable: true type: object securitySchemes: bearerAuth: bearerFormat: Personal Access Token scheme: bearer type: http sessionAuth: in: cookie name: control_plane_session type: apiKey