Customer Auths API

create new entry

POST /api/rest/admin/customers-auths

Parameters

Name	Description
data[type]	Resource type (customers-auths)
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
data[relationships][customer]	Customer
data[relationships][rateplan]	Rateplan
data[relationships][routing-plan]	Routing plan
data[relationships][gateway]	Gateway
data[relationships][account]	Account
data[relationships][diversion-policy]	Diversion policy
data[relationships][pop]	Pop
data[relationships][dst-numberlist]	Dst numberlist
data[relationships][src-numberlist]	Src numberlist
data[relationships][radius-auth-profile]	Radius auth profile
data[relationships][radius-accounting-profile]	Radius accounting profile
data[relationships][transport-protocol]	Transport protocol
data[relationships][tag-action]	Tag action

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MTAyNTQ3MjgsInN1YiI6NTd9.m3KTEd7yWWklqykRJdA_uYG5CsEDpwgN3heb-0pR46c
Host: example.org
Cookie: 

Route

POST /api/rest/admin/customers-auths

Body

{"data":{"type":"customers-auths","attributes":{"name":"name","ip":"0.0.0.0","enabled":true,"reject-calls":false,"dump-level-id":3,"external-id":123,"external-type":"test"},"relationships":{"customer":{"data":{"type":"contractors","id":40}},"rateplan":{"data":{"type":"rateplans","id":17}},"routing-plan":{"data":{"type":"routing-plans","id":4}},"gateway":{"data":{"type":"gateways","id":19}},"account":{"data":{"type":"accounts","id":44}},"diversion-policy":{"data":{"type":"diversion-policies","id":1}}}}}

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/"5a5a75e396301ed1b6ac5d1a1e6a0825"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ae7541cf-0687-4859-b2d5-bbbd51746484
X-Runtime: 0.046237
Content-Length: 3695

Status

201 Created

Body

{
  "data": {
    "id": "20087",
    "type": "customers-auths",
    "links": {
      "self": "http://example.org/api/rest/admin/customers-auths/20087"
    },
    "attributes": {
      "name": "name",
      "ip": [
        "0.0.0.0"
      ],
      "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": null,
      "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": 123,
      "external-type": "test",
      "dump-level-id": 3
    },
    "relationships": {
      "customer": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/customer",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/customer"
        }
      },
      "rateplan": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/rateplan",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/rateplan"
        }
      },
      "routing-plan": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/routing-plan",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/routing-plan"
        }
      },
      "gateway": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/gateway",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/gateway"
        }
      },
      "account": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/account",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/account"
        }
      },
      "diversion-policy": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/diversion-policy",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/diversion-policy"
        }
      },
      "pop": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/pop",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/pop"
        }
      },
      "dst-numberlist": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/dst-numberlist",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/dst-numberlist"
        }
      },
      "src-numberlist": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/src-numberlist",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/src-numberlist"
        }
      },
      "tag-action": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/tag-action",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/tag-action"
        }
      },
      "radius-auth-profile": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/radius-auth-profile",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/radius-auth-profile"
        }
      },
      "radius-accounting-profile": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/radius-accounting-profile",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/radius-accounting-profile"
        }
      },
      "transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/customers-auths/20087/relationships/transport-protocol",
          "related": "http://example.org/api/rest/admin/customers-auths/20087/transport-protocol"
        }
      }
    }
  }
}