/organizations/{organization_id}/projects/{project_id}/shares/{share_id}/settings/share_ip_address_filter

This endpoint allows you to manage share IP address filters.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/shares/788962653/settings/share_ip_address_filter" -d '{"accepting":false,"addresses":"10.0.0.3, 10.0.45.102/10"}' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer access_token" \
-H "Host: example.org" \
-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
accepting Required boolean Accepting
addresses Required integer Port

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
PUT 200 OK
DELETE 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity No value given for addresses parameter
PUT 422 Unprocessable Entity Submitted parameter with invalid or empty value

Response Attributes

Name Type Description
accepting boolean Accepting
addresses string IP addresses

Show a share IP address filter for a share

GET /organizations/{organization_id}/projects/{project_id}/shares/{share_id}/settings/share_ip_address_filter

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/shares/788962653/settings/share_ip_address_filter" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"2ba5dc50cd711dac64935e601c515f27"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 06781fb2-238c-4e57-ac6a-571e9abe737b
X-Runtime: 0.027546
Content-Length: 72

Success Response Example

200 OK
{
"accepting": true,
"addresses": "10.0.200.119, 10.2.200.201, 10.0.6.4/30"
}


Create a share IP address filter

POST /organizations/{organization_id}/projects/{project_id}/shares/{share_id}/settings/share_ip_address_filter

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/shares/788962653/settings/share_ip_address_filter" -d '{"accepting":false,"addresses":"10.0.0.3, 10.0.45.102/10"}' -X POST

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"6adecdcb88d3d3b210505e13c21f65ce"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: bc4d20a4-53b8-40c7-b95b-d076954012e1
X-Runtime: 0.034505
Content-Length: 58

Success Response Example

201 Created
{
  "accepting": false,
  "addresses": "10.0.0.3, 10.0.45.102/10"
}


Update a share IP address filter

PUT /organizations/{organization_id}/projects/{project_id}/shares/{share_id}/settings/share_ip_address_filter

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/shares/788962653/settings/share_ip_address_filter" -d '{"accepting":true,"addresses":"10.0.0.3, 10.0.45.102/10"}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"5a5368ed80b3eb4ea9674d2f7df12172"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 970cf6fd-c458-41ff-8b05-09bdf7af6e72
X-Runtime: 0.035251
Content-Length: 57

Success Response Example

200 OK
{
  "accepting": true,
  "addresses": "10.0.0.3, 10.0.45.102/10"
}

Error Response Example

422 Unprocessable Entity
{
      "errors": {
        "accepting": [
          "is not included in the list",
          "is not included in the list"
        ],
        "addresses": [
          "can't be blank"
        ]
      }
    }


Remove a share IP address filter

DELETE /organizations/{organization_id}/projects/{project_id}/shares/{share_id}/settings/share_ip_address_filter

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/shares/788962653/settings/share_ip_address_filter" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
  Cache-Control: no-cache
  X-Request-Id: bc8ec57a-c009-48ae-aa2d-5155a1e4ad60
  X-Runtime: 0.029935

Success Response Example

204 No Content

Video player

Video

×