Shares

Create, list, and revoke links that give others read-only access to a pipeline.

/spaces/{spaceId}/shares
  • GETList pipeline shares in the space.

    Sample request

    GET /spaces/space_123/shares HTTP/1.1
    Host: api.munchii.com
    Authorization: Bearer <access-token>

    Example response

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
      "data": [
        {
          "self": {
            "id": "share_123",
            "name": "share_123"
          },
          "pipelineName": "web",
          "target": {
            "kind": "pipeline",
            "id": "pipeline_123"
          },
          "expiresAt": "2026-01-15T12:30:00.000Z",
          "createdAt": "2026-01-15T12:00:00.000Z",
          "createdBy": "user_123"
        }
      ]
    }

    Common errors

    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space was not found.
  • POSTCreate a time-limited share for a pipeline.

    Sample request

    POST /spaces/space_123/shares HTTP/1.1
    Host: api.munchii.com
    Authorization: Bearer <access-token>
    Content-Type: application/json
    
    {
      "pipelineName": "web",
      "duration": "PT30M"
    }

    Example response

    HTTP/1.1 201 Created
    Content-Type: application/json
    
    {
      "data": {
        "self": {
          "id": "share_123",
          "name": "share_123"
        },
        "pipelineName": "web",
        "target": {
          "kind": "pipeline",
          "id": "pipeline_123"
        },
        "expiresAt": "2026-01-15T12:30:00.000Z",
        "createdAt": "2026-01-15T12:00:00.000Z",
        "createdBy": "user_123"
      }
    }

    Common errors

    • 400 The body or requested share duration is invalid.
    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space or pipeline was not found.
/spaces/{spaceId}/shares/{shareId}
  • DELETERevoke a pipeline share.

    Sample request

    DELETE /spaces/space_123/shares/share_123 HTTP/1.1
    Host: api.munchii.com
    Authorization: Bearer <access-token>

    Example response

    HTTP/1.1 204 No Content

    Empty response body.

    Common errors

    • 401 The credentials are missing, expired, or invalid.
    • 403 The caller lacks permission for this operation.
    • 404 The space or share was not found.