Customer Auths API

update values

PUT /api/rest/admin/customers-auths/:id

Parameters

Name	Description
data[type]	Resource type (customers-auths)
data[id]	Customer Auth ID
data[attributes][name]	Name
data[attributes][ip]	Ip
data[attributes][enabled]	Enabled
data[attributes][reject-calls]	Reject calls
data[attributes][src-rewrite-rule]	Src rewrite rule
data[attributes][src-rewrite-result]	Src rewrite result
data[attributes][dst-rewrite-rule]	Dst rewrite rule
data[attributes][dst-rewrite-result]	Dst rewrite result
data[attributes][src-prefix]	Src prefix
data[attributes][dst-prefix]	Dst prefix
data[attributes][x-yeti-auth]	X yeti auth
data[attributes][capacity]	Capacity
data[attributes][uri-domain]	Uri domain
data[attributes][src-name-rewrite-rule]	Src name rewrite rule
data[attributes][src-name-rewrite-result]	Src name rewrite result
data[attributes][diversion-rewrite-rule]	Diversion rewrite rule
data[attributes][diversion-rewrite-result]	Diversion rewrite result
data[attributes][allow-receive-rate-limit]	Allow receive rate limit
data[attributes][send-billing-information]	Send billing information
data[attributes][enable-audio-recording]	Enable audio recording
data[attributes][src-number-radius-rewrite-rule]	Src number radius rewrite rule
data[attributes][src-number-radius-rewrite-result]	Src number radius rewrite result
data[attributes][dst-number-radius-rewrite-rule]	Dst number radius rewrite rule
data[attributes][dst-number-radius-rewrite-result]	Dst number radius rewrite result
data[attributes][from-domain]	From domain
data[attributes][to-domain]	To domain
data[attributes][tag-action-value]	Tag action value
data[attributes][check-account-balance]	Check account balance
data[attributes][require-incoming-auth]	Require incoming auth
data[attributes][dump-level-id]	Dump level id
data[attributes][external-id]	External id
data[attributes][external-type]	External type

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NTMsInN1YiI6Nzh9.U9eZ3Rrpxd9JkpHR9TRTwD23SDjr9C4pw8a3eQihXFw
Host: example.org
Cookie: 

Route

PUT /api/rest/admin/customers-auths/20088

Body

{"data":{"type":"customers-auths","id":20088,"attributes":{"name":"name","capacity":2}}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"98e1bc27ddbc89560a274c2803facdb6"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 769e907a-8590-409b-9fb5-0f4068c9d7dd
X-Runtime: 0.051150
Content-Length: 4018

Status

200 OK

Body

{
  "data": {
    "id": "20088",
    "type": "customers-auths",
    "links": {
      "self": "http://example.org/api/rest/admin/customers-auths/20088"
    },
    "attributes": {
      "name": "name",
      "ip": [
        "127.0.0.0/8"
      ],
      "enabled": true,
      "reject-calls": false,
      "src-rewrite-rule": null,
      "src-rewrite-result": null,
      "dst-rewrite-rule": null,
      "dst-rewrite-result": null,
      "src-prefix": [
        ""
      ],
      "src-number-min-length": 0,
      "src-number-max-length": 100,
      "dst-prefix": [
        ""
      ],
      "dst-number-min-length": 0,
      "dst-number-max-length": 100,
      "x-yeti-auth": [

      ],
      "capacity": 2,
      "cps-limit": null,
      "uri-domain": [

      ],
      "src-name-rewrite-rule": null,
      "src-name-rewrite-result": null,
      "diversion-rewrite-rule": null,
      "diversion-rewrite-result": null,
      "allow-receive-rate-limit": false,
      "send-billing-information": false,
      "enable-audio-recording": false,
      "src-number-radius-rewrite-rule": null,
      "src-number-radius-rewrite-result": null,
      "dst-number-radius-rewrite-rule": null,
      "dst-number-radius-rewrite-result": null,
      "check-account-balance": true,
      "require-incoming-auth": false,
      "from-domain": [

      ],
      "to-domain": [

      ],
      "tag-action-value": [

      ],
      "external-id": null,
      "external-type": null,
      "dump-level-id": 1
    },
    "relationships": {
      "customer": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/customer",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/customer"
        },
        "data": {
          "type": "contractors",
          "id": "63"
        }
      },
      "rateplan": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/rateplan",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/rateplan"
        },
        "data": {
          "type": "rateplans",
          "id": "18"
        }
      },
      "routing-plan": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/routing-plan",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/routing-plan"
        },
        "data": {
          "type": "routing-plans",
          "id": "5"
        }
      },
      "gateway": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/gateway",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/gateway"
        },
        "data": {
          "type": "gateways",
          "id": "20"
        }
      },
      "account": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/account",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/account"
        },
        "data": {
          "type": "accounts",
          "id": "67"
        }
      },
      "diversion-policy": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/diversion-policy",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/diversion-policy"
        },
        "data": {
          "type": "diversion-policies",
          "id": "1"
        }
      },
      "pop": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/pop",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/pop"
        },
        "data": null
      },
      "dst-numberlist": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/dst-numberlist",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/dst-numberlist"
        },
        "data": null
      },
      "src-numberlist": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/src-numberlist",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/src-numberlist"
        },
        "data": null
      },
      "tag-action": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/tag-action",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/tag-action"
        },
        "data": null
      },
      "radius-auth-profile": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/radius-auth-profile",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/radius-auth-profile"
        },
        "data": null
      },
      "radius-accounting-profile": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/radius-accounting-profile",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/radius-accounting-profile"
        },
        "data": null
      },
      "transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20088/relationships/transport-protocol",
          "related": "http://example.org/api/rest/admin/customers-auths/20088/transport-protocol"
        },
        "data": null
      }
    }
  }
}