Sign in
Portal Links

Create a portal link

This endpoint creates a portal link

post/v1/projects/{projectID}/portal-links

Path parameters

projectIDstring required

Project ID

Request body

auth_typestring
can_manage_endpointboolean

Specify whether endpoint management can be done through the Portal Link UI

endpointsstring[]

Deprecated IDs of endpoints in this portal link

namestring

Portal Link Name

owner_idstring

OwnerID, the portal link will inherit all the endpoints with this owner ID

Response

Created

messagestring
statusboolean

Changes

Changed in 14 of the 69 revisions of this API.123623

  • v3c6c04abdfb6f1See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/allOf[datastore.Endpoint]/teams_webhook_url to the response with the 201 status

      response-optional-property-added

  • v3bae289777c919284See the full diff
    • ▲

      the response property allOf[subschema #2]/data became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data became nullable for the status 404

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/deleted_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/endpoints_metadata/items/ became nullable for the status 201

      response-property-became-nullable

    • ▲

      the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 400

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 401

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 404

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data/endpoints_metadata/items/ response's property type/format changed from object/ to / for status 201

      response-property-type-changed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/advanced_signatures from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/authentication from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/cb_state from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/content_type from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/created_at from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/deleted_at from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/description from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/events from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/failure_count from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/failure_rate from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/http_timeout from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/mtls_client_cert from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/name from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/owner_id from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/period_failure_rate from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/project_id from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/rate_limit from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/rate_limit_duration from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/retry_count from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/secrets from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/slack_webhook_url from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/status from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/success_count from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/support_email from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/uid from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/updated_at from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/endpoints_metadata/items/url from the response with the 201 status

      response-optional-property-removed

    • ●

      added the new enum value to the allOf[subschema #2]/data/auth_type response property for the response status 201

      response-property-enum-value-added

    • ○

      added datastore.Endpoint to the allOf[subschema #2]/data/endpoints_metadata/items/ response property allOf list for the response status 201

      response-property-all-of-added

    • ○

      added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 400

      response-property-all-of-added

    • ○

      added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 401

      response-property-all-of-added

    • ○

      added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 404

      response-property-all-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v32e8ab34176ea2See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/cb_state to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/retry_count to the response with the 201 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v321fa7ff1d01a3See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/failure_count to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/period_failure_rate to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/success_count to the response with the 201 status

      response-optional-property-added

  • v3990a51cff1cc11See the full diff
    • ●

      added the new basic_auth enum value to the allOf[subschema #2]/data/endpoints_metadata/items/authentication/type response property for the response status 201

      response-property-enum-value-added

    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/authentication/basic_auth to the response with the 201 status

      response-optional-property-added

  • v3af9526d13dc81See the full diff
    • ○

      removed the pending enum value from the allOf[subschema #2]/data/endpoints_metadata/items/status response property for the response status 201

      response-property-enum-value-removed

  • v388eaa000293b11See the full diff
    • ●

      added the new oauth2 enum value to the allOf[subschema #2]/data/endpoints_metadata/items/authentication/type response property for the response status 201

      response-property-enum-value-added

    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/authentication/oauth2 to the response with the 201 status

      response-optional-property-added

  • v3801a0bbf87fd2See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/content_type to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/endpoints_metadata/items/mtls_client_cert to the response with the 201 status

      response-optional-property-added

  • v300864c7aced02See the full diff
    • ○

      added the new optional request property auth_type

      new-optional-request-property

    • ○

      added the optional property allOf[subschema #2]/data/auth_type to the response with the 201 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3180e3a788b5b1See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/auth_key to the response with the 201 status

      response-optional-property-added