Skip to main content
Version: Mosquitto 3.0

Projects

Available API Paths

/api/projects​

The following methods are available for this path:

GET​

Return a list of all available projects the caller owns or is member of.

Responses

Status Description Response Content or Scheme
200 A list of projects. 
{
  "id": {
    "type": "string",
    "title": "id"
  },
  "name": {
    "type": "string",
    "title": "name"
  },
  "description": {
    "type": "string",
    "title": "description"
  },
  "owner": {
    "allOf": [
      {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "title": "userId"
          },
          "organizationId": {
            "type": "string",
            "title": "organizationId"
          }
        },
        "additionalProperties": false,
        "title": "Owner"
      },
      {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "title": "name"
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      }
    ],
    "title": "Owner"
  },
  "role": {
    "type": "string",
    "enum": [
      "admin",
      "editor",
      "viewer"
    ],
    "title": "MemberRole"
  }
}
401 Unauthorized request error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
403 Request is not allowed error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
404 Resource is not found error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
405 Method not supported for this resource 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
500 Internal server error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}

/api/projects/{projectId}/settings​

The following methods are available for this path:

GET​

Return settings for the project specified by passed id.

Parameters

NameLocationTypeDescription
projectIdpathstringA project id
Responses

Status Description Response Content or Scheme
200 The project settings. 
{
  "project": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "title": "id"
      },
      "user_id": {
        "title": "user_id",
        "type": [
          "string",
          "null"
        ]
      },
      "name": {
        "type": "string",
        "title": "name"
      },
      "description": {
        "type": "string",
        "title": "description"
      },
      "owner": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "title": "userId"
          },
          "organizationId": {
            "type": "string",
            "title": "organizationId"
          }
        },
        "additionalProperties": false,
        "title": "Owner"
      }
    },
    "required": [
      "id",
      "user_id",
      "name",
      "description",
      "owner"
    ],
    "additionalProperties": false,
    "title": "Project"
  },
  "owner": {
    "type": "object",
    "properties": {
      "userId": {
        "type": "string",
        "title": "userId"
      },
      "organizationId": {
        "type": "string",
        "title": "organizationId"
      }
    },
    "additionalProperties": false,
    "title": "Owner"
  },
  "services": {
    "type": "array",
    "items": {
      "title": "BrokerConfig",
      "anyOf": [
        {
          "title": "CloudBroker",
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "cloud"
            },
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "project_id": {
              "type": "string"
            },
            "ha": {
              "type": "boolean"
            },
            "created_at": {
              "type": "string"
            },
            "updated_at": {
              "type": "string"
            },
            "url": {
              "type": "string"
            },
            "verify_ca_cert": {
              "type": " boolean"
            },
            "canceled_at": {
              "type": [
                "string",
                "null"
              ]
            },
            "issued_to": {
              "type": "string"
            },
            "product_id": {
              "type": "string"
            },
            "stripe_subscription_item_id": {
              "type": [
                "string",
                "null"
              ]
            },
            "period_start": {
              "type": "string"
            },
            "period_end": {
              "type": [
                "string",
                "null"
              ]
            },
            "options": {
              "type": "string"
            },
            "subdomain": {
              "type": "string"
            },
            "zone_name": {
              "type": "string"
            },
            "deployed_at": {
              "type": [
                "string",
                "null"
              ]
            },
            "shutdown_at": {
              "type": [
                "string",
                "null"
              ]
            },
            "location": {
              "type": "string",
              "enum": [
                "fsn1",
                "nbg1",
                "hel1",
                "ash",
                "hil"
              ]
            },
            "state": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "active",
                    "inactive"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "new",
                    "provisioning",
                    "updating",
                    "error",
                    "stopping_payment",
                    "payment_stopped",
                    "shutting_down"
                  ]
                }
              ]
            },
            "target_state": {
              "type": "string",
              "enum": [
                "active",
                "inactive"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "type",
            "project_id",
            "ha",
            "created_at",
            "updated_at",
            "url",
            "verify_ca_cert",
            "issued_to",
            "product_id",
            "period_start",
            "options",
            "subdomain",
            "zone_name",
            "location",
            "state",
            "target_state"
          ],
          "additionalProperties": false
        },
        {
          "title": "SelfHostedBroker",
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "self-hosted"
            },
            "ha": {
              "type": "boolean"
            },
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "project_id": {
              "type": "string"
            },
            "created_at": {
              "type": "string"
            },
            "updated_at": {
              "type": "string"
            },
            "url": {
              "type": "string"
            },
            "verify_ca_cert": {
              "type": "boolean"
            }
          },
          "required": [
            "type",
            "ha",
            "id",
            "name",
            "project_id",
            "created_at",
            "updated_at",
            "url",
            "verify_ca_cert"
          ],
          "additionalProperties": false
        },
        {
          "title": "OnPremiseSetupBroker",
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "on-premise-setup"
            },
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "project_id": {
              "type": "string"
            },
            "ha": {
              "type": "boolean"
            },
            "created_at": {
              "type": "string"
            },
            "updated_at": {
              "type": "string"
            },
            "issued_to": {
              "type": "string"
            },
            "canceled_at": {
              "type": [
                "string",
                "null"
              ]
            },
            "product_id": {
              "type": "string"
            },
            "period_start": {
              "type": "string"
            },
            "stripe_subscription_item_id": {
              "type": [
                "string",
                "null"
              ]
            },
            "period_end": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "type",
            "id",
            "name",
            "project_id",
            "ha",
            "created_at",
            "updated_at",
            "issued_to",
            "product_id",
            "period_start"
          ],
          "additionalProperties": false
        }
      ]
    }
  }
}
401 Unauthorized request error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
403 Request is not allowed error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
404 Resource is not found error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
405 Method not supported for this resource 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
500 Internal server error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}