On this page

    1. Home
    2. API
    3. API Reference
    4. Network
    5. Block Location

    Block Location

    The block-location endpoint allows you to restrict your provider devices from facilitating connections for specific geographic regions. This is useful for compliance, security, or performance optimization.


    POST /network/block-location

    Adds a specific location to your network's blocklist.

    Request

    POST /network/block-location

    Headers:

    {
      "Host": "api.bringyour.com",
      "Content-Type": "application/json",
      "Authorization": "Bearer YOUR_JWT_TOKEN"
    }

    Body:

    {
      "location_id": "uuid"
    }
    FieldTypeDescription
    location_idstringThe unique UUID of the location to block.

    Response

    200 Success

    Status: 200 OK Content-Type: application/json

    {}

    A successful response returns an empty object, indicating the location has been added to your blocklist.

    Example

    HTTP Request

    POST /network/block-location HTTP/1.1
    Host: api.bringyour.com
    Content-Type: application/json
    Authorization: Bearer YOUR_JWT_TOKEN
     
    {
      "location_id": "c73040c1-0000-0000-0000-000000000000"
    }

    Successful HTTP Response

    {}


    Powered by Sudoc v2.5.0
    Hide table of contents