Archestra AI Site Notification API

The Site Notification API from Archestra AI — 3 operation(s) for site notification.

Operations 5

GET /api/site-notification Get site notification #
POST /api/site-notification Create site notification #
GET /api/site-notification/settings Get site notification settings #
PUT /api/site-notification/{id} Update site notification #
DELETE /api/site-notification/{id} Delete site notification #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/archestra:archestra-site-notification-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

archestra-site-notification-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Archestra Site Notification API
  version: 1.4.0-rc.47
tags:
- name: Site Notification
paths:
  /api/site-notification:
    get:
      operationId: getSiteNotification
      tags:
      - Site Notification
      description: 'Get the active site notification for the current organization


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        None (no additional RBAC permission required)'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type:
                - object
                - 'null'
                properties:
                  id:
                    type: string
                  content:
                    type: string
                  expiresAt:
                    type:
                    - string
                    - 'null'
                  createdAt:
                    type: string
                  isActive:
                    type: boolean
                required:
                - id
                - content
                - expiresAt
                - createdAt
                - isActive
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: none
        note: None (no additional RBAC permission required)
        permissions: []
      summary: Get site notification
      x-summary-source: derived
    post:
      operationId: createSiteNotification
      tags:
      - Site Notification
      description: 'Create a new site notification


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                content:
                  type: string
                  minLength: 1
                expiresAt:
                  type: string
                  format: date-time
                  pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
              required:
              - content
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  content:
                    type: string
                  expiresAt:
                    type:
                    - string
                    - 'null'
                  createdAt:
                    type: string
                  isActive:
                    type: boolean
                required:
                - id
                - content
                - expiresAt
                - createdAt
                - isActive
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Create site notification
      x-summary-source: derived
  /api/site-notification/settings:
    get:
      operationId: getSiteNotificationSettings
      tags:
      - Site Notification
      description: 'Get the latest site notification for settings management


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:read`: View every organization settings page, including messaging channels'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type:
                - object
                - 'null'
                properties:
                  id:
                    type: string
                  content:
                    type: string
                  expiresAt:
                    type:
                    - string
                    - 'null'
                  createdAt:
                    type: string
                  isActive:
                    type: boolean
                required:
                - id
                - content
                - expiresAt
                - createdAt
                - isActive
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:read
      summary: Get site notification settings
      x-summary-source: derived
  /api/site-notification/{id}:
    put:
      operationId: updateSiteNotification
      tags:
      - Site Notification
      description: 'Update an existing site notification


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                content:
                  type: string
                  minLength: 1
                expiresAt:
                  type:
                  - string
                  - 'null'
                  format: date-time
                  pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                isActive:
                  type: boolean
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  content:
                    type: string
                  expiresAt:
                    type:
                    - string
                    - 'null'
                  createdAt:
                    type: string
                  isActive:
                    type: boolean
                required:
                - id
                - content
                - expiresAt
                - createdAt
                - isActive
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Update site notification
      x-summary-source: derived
    delete:
      operationId: deleteSiteNotification
      tags:
      - Site Notification
      description: 'Delete a site notification


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Delete site notification
      x-summary-source: derived