GEgetconvoy
Onboard

Bulk onboard endpoints with subscriptions

Changed on

This endpoint bulk-creates endpoints with subscriptions from a JSON body. A CSV file upload is also accepted over raw HTTP as multipart/form-data with a "file" field; generated SDK clients only expose the JSON body.

post/v1/projects/{projectID}/onboard

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    HTTP bearer

Path parameters

projectIDstring required

Project ID

Query parameters

dry_runboolean

Validate without creating

Request body

Response

OK

messagestring
statusboolean

Changes

  • v3bae289777c91Revision changes
    • breaking

      removed the media type application/octet-stream from the request body

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • info

      added the media type application/json to the request body

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

  • v3743b89d7f7d3Revision changes
    • info

      endpoint added