mirror/peeringdb-peeringdb
1
0
Fork 0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Code Releases Activity
Files
5d6b6ffb310a568c08afce47b3b954fe1f2bf12f
peeringdb-peeringdb/peeringdb_server/static/api-schema.yaml
Matt Griswold ea55c4dc38 July updates (#762) 
* Change label from primary ASN to ASN

* Raise validation error when trying to update ASN

* first steps for dotf importer procotol (#697)

* migrations (#697)

* Add translation to error meessage

* Make ASN readonly in table

* Add test now that ASN should not be able to update

* Set fac.rencode to '' for all entries and make it readonly in serializer

* Add unique constraints to network ixlan ip addresses

* Add migration to null out duplicate ipaddresses for deleted netixlans

* Add unique constraints to network ixlan ip addresses

* Add migration to null out duplicate ipaddresses for deleted netixlans

* remove old migrations (#697)

* fix netixlan ipaddr dedupe migration (#268)
add netixlan ipaddr unique constraint migration (#268)

* ixf_member_data migrations (#697)

* fix table name (#697)

* importer protocol (#697)

* fix netixlan ipaddr dedupe migration (#268)
add netixlan ipaddr unique constraint migration (#268)

* ixf proposed changes notifications (#697)

* Delete repeated query

* Add a test to show rencode is readonly

* Blank out rencode when mocking data

* Remove validator now that constraint exists

* Add back unique field validator w Check Deleted true

* conflict resolving (#697)

* UniqueFieldValidator raise error with code "unique" (#268)

* conflict resolution (#697)

* Add fixme comment to tests

* conflict resolution (#697)

* Remove now invalid undelete tests

* UniqueFieldValidator raise error with code "unique" (#268)

* delete admin tools for duplicate ip addresses

* Make migration to delete duplicateipnetworkixlan

* Add ixlan-ixpfx status matching validation, add corresponding test

* delete redundant checking in test

* resolve conflict ui (#697)

* fix migrations hierarchy

* squash migrations for ixf member data

* clean up preview and post-mortem tools

* remove non-sensical permission check when undeleting soft-deleted objects through unique integrity error handling

* only include the ix-f data url in notifications to admincom (#697)

* resolve on --skip-import (#697)

* ac conflict resolution (#697)

* Define more accurately the incompatible statuses for ixlan and ixpfx

* Add another status test

* Preventing disrupting changes (#697)

* fix tests (#697)

* Stop allow_ixp_update from being write only and add a global stat for automated networks

* Add tests for global stats that appear in footer

* Change how timezone is called with datetime, to get test_stats.py/test_generate_for_current_date to pass

* test for protected entities (#697)

* admincom conflict resolution refine readonly fields (#697)
network notifications only if the problem is actually actionable by the network (#697)

* ixp / ac notifcation when ix-f source cannot be parsed (#697)
fix issue with ixlan prefix protection (#697)

* migrations (#697)

* code documentation (#697)

* ux tweaks (#697)

* UX tweaks (#697)

* Fix typo

* fix netixlan returned in IXFMemberData.apply when adding a new one (#697)

* fix import log incosistencies (#697)

* Add IXFMemberData to test

* Update test data

* Add protocol tests

* Add tests for views

* always persist changes to remote data on set_conflict (#697)

* More tests

* always persist changes to remote data on set_conflict (#697)

* suggest-add test

* net_present_at_ix should check status (#697)

* Add more protocol tests

* Edit language of some tests

* django-peeringdb to 2.1.1
relock pipfile, pin django-ratelimit to <3 as it breaks stuff

* Add net_count_ixf field to ix object (#683)

* Add the IX-F Member Export URL to the ixlan API endpoint (#249)

* Lock some objects from being deleted by the owner (#696)

* regenerate api docs (#249)

* always persist changes to remote data on set_add and set_update (#697)

* IXFMemberData: always persist remote data changes during set_add and set_update, also allow for saving without touching the updated field

* always persist changes to remote data on set_add and set_update (#697)

* Fix suggest-add tests

* IXFMemberData: always persist remote data changes during set_add and set_update, also allow for saving without touching the updated field

* IXFMemberData: always persist remote data changes during set_add and set_update, also allow for saving without touching the updated field

* fix issue with deletion when ixfmemberdata for entry existed previously (#697)

* fix test_suggest_delete_local_ixf_no_flag (#697 tests)

* fix issue with deletion when ixfmemberdata for entry existed previously (#697)

* invalid ips get logged and notified to the ix via notify_error (#697)

* Fix more tests

* issue with previous_data when running without save (#697)
properly track speed errors (#697)

* reset errors on ixfmemberdata that go into pending_save (#697)

* add remote_data to admin view (#697)

* fix error reset inconsistency (#697)

* Refine invalid data tests

* remove debug output

* for notifications to ac include contact points for net and ix in the message (#697)

* settings to toggle ix-f tickets / emails (#697)

* allow turning off ix-f notifications for net and ix separately (#697)

* add jsonschema test

* Add idempotent tests to updater

* remove old ixf member tests

* Invalid data tests when ixp_updates are enabled

* fix speed error validation (#697)

* fix issue with rollback (#697)

* fix migration hierarchy

* fix ixfmemberdata _email

* django-peeringdb to 2.2 and relock

* add ixf rollback tests

* ixf email notifications off by default

* black formatted

* pyupgrade

Co-authored-by: egfrank <egfrank@20c.com>
Co-authored-by: Stefan Pratter <stefan@20c.com>
2020-07-15 07:07:01 +00:00

32800 lines
1.2 MiB
Raw Blame History

openapi: 3.0.2
info:
title: ''
version: ''
paths:
/api/fac:
get:
operationId: list fac
description: "Retrieves a list of `fac` type objects\n\n## Facility (Datacenter)\
\ \n\nIdentified by the `fac` tag.\n\n### Parent relationship:\n\n- `org`\
\ organization\n\n### Relationship(s):\n\n- `ixfac` exchange / facility presence\n\
- `netfac` network / facility presence\n\n\n## List objects\n\n### Querying\n\
\nYou may query the resultset by passing field names as url parameters\n\n\
### Numeric Queries\n\nOn numeric fields you can suffix the field names with\
\ the following filters:\n\n- \\_\\_lt : less-than\n- \\_\\_lte : less-than-equal\n\
- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n- \\_\\_in :\
\ value inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__lt=10\n\
\ ?<field_name>__in=1,10\n\n### String Queries\n\nOn string fields you\
\ can suffix the field names with the following filters:\n\n- \\_\\_contains\
\ : field value contains specified value\n- \\_\\_startswith : field value\
\ starts with specified value\n- \\_\\_in : value contained inside set of\
\ values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters:
- name: address1
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: address2
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: clli
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: geocode_date
in: query
description: 'Last time of attempted geocode
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: geocode_error
in: query
description: 'Error message of previous geocode attempt
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: geocode_status
in: query
description: 'Has this object''s latitude and longitude been syncronized to
it''s address fields
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: latitude
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: number
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: longitude
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: number
- name: name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net_count
in: query
description: 'Number of networks present at this facility
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: npanxx
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__address1
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__address2
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: org__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__state
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: org__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__zipcode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: rencode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: sales_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: sales_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: state
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: tech_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: tech_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: zipcode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
description: ''
post:
operationId: create fac
description: "Creates a new `fac` type object.\n\n## Facility (Datacenter) \n\
\nIdentified by the `fac` tag.\n\n### Parent relationship:\n\n- `org` organization\n\
\n### Relationship(s):\n\n- `ixfac` exchange / facility presence\n- `netfac`\
\ network / facility presence\n\n\n## Creating objects\n\n### Status `pending`\n\
\nSome object types will be flagged as `pending` until they have been reviewed\
\ and approved by peeringdb staff.\n\nCurrently this is the case for:\n\n\n\
- `org` organizations (only administrative staff users are currently allowed\
\ to create organizations)\n- `fac` facilities\n- `net` networks\n- `ix` exchanges\n\
- `ixpfx` prefixes (if part of a new exchange)\n- `ixlan` exchange networks\
\ (if part of a new exchange)\n\n### Permissions\n\nTo be able to create an\
\ object, the requesting user requires `create` permissions to one of the\n\
object's parents in the relationship hierarchy.\n\nFor example to create a\
\ `net` type object, the user needs to be permissioned to create in the organzation\n\
that is to be the network's holder entity.\n"
parameters: []
requestBody:
content:
application/json:
schema: &id001
properties:
org_id:
type: integer
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
application/x-www-form-urlencoded:
schema: *id001
multipart/form-data:
schema: *id001
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
description: ''
/api/fac/{id}:
get:
operationId: retrieve fac
description: "Retrieves a single `fac` type object by id\n\n## Facility (Datacenter)\
\ \n\nIdentified by the `fac` tag.\n\n### Parent relationship:\n\n- `org`\
\ organization\n\n### Relationship(s):\n\n- `ixfac` exchange / facility presence\n\
- `netfac` network / facility presence\n\n\n## Retrieve a single object\n\n\
### Depth\n\nNested sets will not be expanded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
description: ''
put:
operationId: update fac
description: "Updates an existing `fac` type object.\n\n## Facility (Datacenter)\
\ \n\nIdentified by the `fac` tag.\n\n### Parent relationship:\n\n- `org`\
\ organization\n\n### Relationship(s):\n\n- `ixfac` exchange / facility presence\n\
- `netfac` network / facility presence\n\n\n## Update existing objects\n\n\
### Permissions\n\nIn order to update an object the requesting user requires\
\ `update` permissions to the object itself or one of the parent relationships\
\ in the object hierarchy\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id002
properties:
org_id:
type: integer
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
application/x-www-form-urlencoded:
schema: *id002
multipart/form-data:
schema: *id002
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
description: ''
patch:
operationId: patch fac
description: "PATCH (partial update) is currently disabled\n\n## Facility (Datacenter)\
\ \n\nIdentified by the `fac` tag.\n\n### Parent relationship:\n\n- `org`\
\ organization\n\n### Relationship(s):\n\n- `ixfac` exchange / facility presence\n\
- `netfac` network / facility presence\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id003
properties:
org_id:
type: integer
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
application/x-www-form-urlencoded:
schema: *id003
multipart/form-data:
schema: *id003
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
description: ''
delete:
operationId: delete fac
description: "Marks an `fac` type object as `deleted`.\n\n## Facility (Datacenter)\
\ \n\nIdentified by the `fac` tag.\n\n### Parent relationship:\n\n- `org`\
\ organization\n\n### Relationship(s):\n\n- `ixfac` exchange / facility presence\n\
- `netfac` network / facility presence\n\n\n## Deleting objects\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/ix:
get:
operationId: list ix
description: "Retrieves a list of `ix` type objects\n\n## Internet Exchange\n\
\nIdentified by the `ix` tag.\n\n### Parent relationship:\n\n- `org` organization\n\
\n### Relationship(s):\n\n- `ixlan` internet exchange network information\n\
- `ixfac` exchange / facility presence\n\n\n## List objects\n\n### Querying\n\
\nYou may query the resultset by passing field names as url parameters\n\n\
### Numeric Queries\n\nOn numeric fields you can suffix the field names with\
\ the following filters:\n\n- \\_\\_lt : less-than\n- \\_\\_lte : less-than-equal\n\
- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n- \\_\\_in :\
\ value inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__lt=10\n\
\ ?<field_name>__in=1,10\n\n### String Queries\n\nOn string fields you\
\ can suffix the field names with the following filters:\n\n- \\_\\_contains\
\ : field value contains specified value\n- \\_\\_startswith : field value\
\ starts with specified value\n- \\_\\_in : value contained inside set of\
\ values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters:
- name: city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: fac
in: query
description: 'Find exchanges present at a facility (facility id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixf_last_import
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ixf_net_count
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixfac
in: query
description: 'Find the exchange that contains this ixfac (ixfac id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: ixlan
in: query
description: 'Find the exchange that contains this ixlan (ixlan id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: media
in: query
description: 'Filter results by matching a value against this field.
`Ethernet`, `ATM`, `Multiple`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: name_long
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net
in: query
description: 'Find exchanges where this network has a presence at (net id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: net_count
in: query
description: 'Number of networks present at this exchange
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__address1
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__address2
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: org__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__state
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: org__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__zipcode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: policy_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: policy_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: proto_ipv6
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: proto_multicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: proto_unicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: region_continent
in: query
description: 'Filter results by matching a value against this field.
`North America`, `Asia Pacific`, `Europe`, `South America`, `Africa`, `Australia`,
`Middle East`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: tech_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: tech_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: url_stats
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET
in Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce
its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed
to add a netixlan entry for this network via their
ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- city
- country
- region_continent
- media
- website
- tech_email
description: ''
post:
operationId: create ix
description: 'Creates a new `ix` type object.
## Internet Exchange
Identified by the `ix` tag.
### Parent relationship:
- `org` organization
### Relationship(s):
- `ixlan` internet exchange network information
- `ixfac` exchange / facility presence
## Creating objects
### Status `pending`
Some object types will be flagged as `pending` until they have been reviewed
and approved by peeringdb staff.
Currently this is the case for:
- `org` organizations (only administrative staff users are currently allowed
to create organizations)
- `fac` facilities
- `net` networks
- `ix` exchanges
- `ixpfx` prefixes (if part of a new exchange)
- `ixlan` exchange networks (if part of a new exchange)
### Permissions
To be able to create an object, the requesting user requires `create` permissions
to one of the
object''s parents in the relationship hierarchy.
For example to create a `net` type object, the user needs to be permissioned
to create in the organzation
that is to be the network''s holder entity.
'
parameters: []
requestBody:
content:
application/json:
schema: &id004
properties:
org_id:
type: integer
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
suggest:
type: boolean
writeOnly: true
prefix:
type: string
writeOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- city
- country
- region_continent
- media
- website
- tech_email
- prefix
application/x-www-form-urlencoded:
schema: *id004
multipart/form-data:
schema: *id004
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in
Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce
its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to
add a netixlan entry for this network via their
ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- city
- country
- region_continent
- media
- website
- tech_email
description: ''
/api/ix/{id}:
get:
operationId: retrieve ix
description: "Retrieves a single `ix` type object by id\n\n## Internet Exchange\n\
\nIdentified by the `ix` tag.\n\n### Parent relationship:\n\n- `org` organization\n\
\n### Relationship(s):\n\n- `ixlan` internet exchange network information\n\
- `ixfac` exchange / facility presence\n\n\n## Retrieve a single object\n\n\
### Depth\n\nNested sets will not be expanded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in
Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce
its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to
add a netixlan entry for this network via their
ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- city
- country
- region_continent
- media
- website
- tech_email
description: ''
put:
operationId: update ix
description: 'Updates an existing `ix` type object.
## Internet Exchange
Identified by the `ix` tag.
### Parent relationship:
- `org` organization
### Relationship(s):
- `ixlan` internet exchange network information
- `ixfac` exchange / facility presence
## Update existing objects
### Permissions
In order to update an object the requesting user requires `update` permissions
to the object itself or one of the parent relationships in the object hierarchy
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id005
properties:
org_id:
type: integer
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
status:
type: string
maxLength: 255
required:
- org_id
- name
- city
- country
- region_continent
- media
- website
- tech_email
application/x-www-form-urlencoded:
schema: *id005
multipart/form-data:
schema: *id005
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in
Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce
its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to
add a netixlan entry for this network via their
ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- city
- country
- region_continent
- media
- website
- tech_email
description: ''
patch:
operationId: patch ix
description: 'PATCH (partial update) is currently disabled
## Internet Exchange
Identified by the `ix` tag.
### Parent relationship:
- `org` organization
### Relationship(s):
- `ixlan` internet exchange network information
- `ixfac` exchange / facility presence
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id006
properties:
org_id:
type: integer
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
suggest:
type: boolean
writeOnly: true
prefix:
type: string
writeOnly: true
status:
type: string
maxLength: 255
application/x-www-form-urlencoded:
schema: *id006
multipart/form-data:
schema: *id006
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in
Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce
its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to
add a netixlan entry for this network via their
ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- city
- country
- region_continent
- media
- website
- tech_email
description: ''
delete:
operationId: delete ix
description: 'Marks an `ix` type object as `deleted`.
## Internet Exchange
Identified by the `ix` tag.
### Parent relationship:
- `org` organization
### Relationship(s):
- `ixlan` internet exchange network information
- `ixfac` exchange / facility presence
## Deleting objects
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/ixfac:
get:
operationId: list ixfac
description: "Retrieves a list of `ixfac` type objects\n\n## Internet Exchange\
\ / Facility presence \n\nIdentified by the `ixfac` tag.\n\n### Parent relationship:\n\
\n- `ix` internet exchange\n\n### Relationship(s):\n\n- `fac` facility\n\n\
\n## List objects\n\n### Querying\n\nYou may query the resultset by passing\
\ field names as url parameters\n\n### Numeric Queries\n\nOn numeric fields\
\ you can suffix the field names with the following filters:\n\n- \\_\\_lt\
\ : less-than\n- \\_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n\
- \\_\\_gte : greater-than-equal\n- \\_\\_in : value inside set of values\
\ (comma separated)\n\n**examples**\n\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\
\n### String Queries\n\nOn string fields you can suffix the field names with\
\ the following filters:\n\n- \\_\\_contains : field value contains specified\
\ value\n- \\_\\_startswith : field value starts with specified value\n- \\\
_\\_in : value contained inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__contains=something\n ?<field_name>__in=this,that\n\
\nAll string filtering operations are case-insensitive\n\n### Since\n\n\n\
You can use the since argument with a unix timestamp (seconds) to retrieve\
\ all\nobjects updated since then. Note that this result will contain objects\
\ that were\ndeleted in that timeframe as well - you can spot them by checking\
\ for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\n### Nested\
\ data\n\nAny field ending in the suffix **_set** is a list of objects in\
\ a relationship with the parent\nobject, you can expand those lists with\
\ the 'depth' parameter as explained below.\n\nThe naming schema of the field\
\ will always tell you which type of object the set is holding\nand will correspond\
\ with the object's endpoint on the API\n\n <object_type>_set\n\nSo a set\
\ called 'net_set' will hold Network objects (api endpoint /net)\n\n### Depth\n\
\nNested sets will not be loaded (any field ending with the _set suffix) unless\
\ the 'depth'\nparameter is passed in the request URL.\n\nDepth can be one\
\ of three values:\n\n - 1 : expand sets into ids (slow)\n - 2 : expand\
\ sets into objects (slower)\n - 0 : dont expand sets at all (default behaviour)\n\
\n**example**\n\n ?depth=1\n\n### Cached Responses\n\nAny request that\
\ does not require lookups will be served a cached result. Cache is updated\
\ approximately every 15 minutes.\n\nYou can spot cached responses by checking\
\ for the \"generated\" property inside the \"meta\" object.\n\n \"meta\"\
\ : {\n // the cached data was last regenerated at this time (epoch)\n\
\ \"generated\" : 1456121358.6301942\n }\n\n**examples**\n\nwill\
\ serve a cached result:\n\n ?depth=2\n\nwill serve a live result:\n\n\
\ ?id__in=1,2\n\n### Resultset limit\n\nAny request that does lookup queries\
\ and has it's **depth** parameter specified will have a result limit of 250\
\ entries, any entries past this limit will be truncated, at which point you\
\ either should be more specific with your query or use the skip and limit\
\ parameters to page through the result set\n\n**examples**\n\nwill serve\
\ a live result and a maximum of 250 rows at a time:\n\n ?updated__gt=2011-01-01&depth=1\n\
\nwill serve a live result and will not be truncated:\n\n ?updated__gt=2011-01-01\n\
\nwill serve a cached result and will not be truncated:\n\n ?depth=1\n\n\
### Pagination\n\nUse the skip and limit parameters to page through results\n\
\n ?updated__gt=2011-01-01&depth=1&limit=250 - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250\
\ - second page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 -\
\ third page\n"
parameters:
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: fac__address1
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__address2
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__clli
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: fac__geocode_date
in: query
description: 'Last time of attempted geocode
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: fac__geocode_error
in: query
description: 'Error message of previous geocode attempt
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__geocode_status
in: query
description: 'Has this object''s latitude and longitude been syncronized to
it''s address fields
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: fac__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: fac__latitude
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: number
- name: fac__longitude
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: number
- name: fac__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__npanxx
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__rencode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__sales_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__sales_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__state
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__tech_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__tech_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: fac__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: fac__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__zipcode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: facility
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix__city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ix__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix__ixf_last_import
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ix__ixf_net_count
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix__media
in: query
description: 'Filter results by matching a value against this field.
`Ethernet`, `ATM`, `Multiple`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__name_long
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__policy_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__policy_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__proto_ipv6
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ix__proto_multicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ix__proto_unicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ix__region_continent
in: query
description: 'Filter results by matching a value against this field.
`North America`, `Asia Pacific`, `Europe`, `South America`, `Africa`, `Australia`,
`Middle East`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__tech_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__tech_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ix__url_stats
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: integer
ix:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
- fac_id
description: ''
post:
operationId: create ixfac
description: "Creates a new `ixfac` type object.\n\n## Internet Exchange / Facility\
\ presence \n\nIdentified by the `ixfac` tag.\n\n### Parent relationship:\n\
\n- `ix` internet exchange\n\n### Relationship(s):\n\n- `fac` facility\n\n\
\n## Creating objects\n\n### Status `pending`\n\nSome object types will be\
\ flagged as `pending` until they have been reviewed and approved by peeringdb\
\ staff.\n\nCurrently this is the case for:\n\n\n- `org` organizations (only\
\ administrative staff users are currently allowed to create organizations)\n\
- `fac` facilities\n- `net` networks\n- `ix` exchanges\n- `ixpfx` prefixes\
\ (if part of a new exchange)\n- `ixlan` exchange networks (if part of a new\
\ exchange)\n\n### Permissions\n\nTo be able to create an object, the requesting\
\ user requires `create` permissions to one of the\nobject's parents in the\
\ relationship hierarchy.\n\nFor example to create a `net` type object, the\
\ user needs to be permissioned to create in the organzation\nthat is to be\
\ the network's holder entity.\n"
parameters: []
requestBody:
content:
application/json:
schema: &id007
properties:
ix_id:
type: integer
fac_id:
type: integer
status:
type: string
maxLength: 255
required:
- ix_id
- fac_id
application/x-www-form-urlencoded:
schema: *id007
multipart/form-data:
schema: *id007
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ix_id:
type: integer
ix:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
- fac_id
description: ''
/api/ixfac/{id}:
get:
operationId: retrieve ixfac
description: "Retrieves a single `ixfac` type object by id\n\n## Internet Exchange\
\ / Facility presence \n\nIdentified by the `ixfac` tag.\n\n### Parent relationship:\n\
\n- `ix` internet exchange\n\n### Relationship(s):\n\n- `fac` facility\n\n\
\n## Retrieve a single object\n\n### Depth\n\nNested sets will not be expanded\
\ (any field ending with the _set suffix) unless the 'depth'\nparameter is\
\ passed in the request URL.\n\nDepth can be one of three values:\n\n - 1\
\ : expand sets into ids (slow)\n - 2 : expand sets into objects (slower)\n\
\ - 0 : dont expand sets at all (default behaviour)\n\n**example**\n\n \
\ ?depth=1\n\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ix_id:
type: integer
ix:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
- fac_id
description: ''
put:
operationId: update ixfac
description: "Updates an existing `ixfac` type object.\n\n## Internet Exchange\
\ / Facility presence \n\nIdentified by the `ixfac` tag.\n\n### Parent relationship:\n\
\n- `ix` internet exchange\n\n### Relationship(s):\n\n- `fac` facility\n\n\
\n## Update existing objects\n\n### Permissions\n\nIn order to update an object\
\ the requesting user requires `update` permissions to the object itself or\
\ one of the parent relationships in the object hierarchy\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id008
properties:
ix_id:
type: integer
fac_id:
type: integer
status:
type: string
maxLength: 255
required:
- ix_id
- fac_id
application/x-www-form-urlencoded:
schema: *id008
multipart/form-data:
schema: *id008
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ix_id:
type: integer
ix:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
- fac_id
description: ''
patch:
operationId: patch ixfac
description: "PATCH (partial update) is currently disabled\n\n## Internet Exchange\
\ / Facility presence \n\nIdentified by the `ixfac` tag.\n\n### Parent relationship:\n\
\n- `ix` internet exchange\n\n### Relationship(s):\n\n- `fac` facility\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id009
properties:
ix_id:
type: integer
fac_id:
type: integer
status:
type: string
maxLength: 255
application/x-www-form-urlencoded:
schema: *id009
multipart/form-data:
schema: *id009
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ix_id:
type: integer
ix:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
- fac_id
description: ''
delete:
operationId: delete ixfac
description: "Marks an `ixfac` type object as `deleted`.\n\n## Internet Exchange\
\ / Facility presence \n\nIdentified by the `ixfac` tag.\n\n### Parent relationship:\n\
\n- `ix` internet exchange\n\n### Relationship(s):\n\n- `fac` facility\n\n\
\n## Deleting objects\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/ixlan:
get:
operationId: list ixlan
description: "Retrieves a list of `ixlan` type objects\n\n## Internet Exchange\
\ Network Information\n\nIdentified by the `ixlan` tag.\n\n### Parent relationship:\n\
\n- `ix` internet exchange\n\n### Relationship(s):\n\n- `ixpfx` prefixes\n\
- `netixlan` network to exchange connections (through ixlan)\n\n\n## List\
\ objects\n\n### Querying\n\nYou may query the resultset by passing field\
\ names as url parameters\n\n### Numeric Queries\n\nOn numeric fields you\
\ can suffix the field names with the following filters:\n\n- \\_\\_lt : less-than\n\
- \\_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n\
- \\_\\_in : value inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\n### String Queries\n\
\nOn string fields you can suffix the field names with the following filters:\n\
\n- \\_\\_contains : field value contains specified value\n- \\_\\_startswith\
\ : field value starts with specified value\n- \\_\\_in : value contained\
\ inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters:
- name: arp_sponge
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: descr
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: dot1q_support
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix__city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ix__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix__ixf_last_import
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ix__ixf_net_count
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix__media
in: query
description: 'Filter results by matching a value against this field.
`Ethernet`, `ATM`, `Multiple`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__name_long
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__policy_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__policy_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__proto_ipv6
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ix__proto_multicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ix__proto_unicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ix__region_continent
in: query
description: 'Filter results by matching a value against this field.
`North America`, `Asia Pacific`, `Europe`, `South America`, `Africa`, `Australia`,
`Middle East`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__tech_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__tech_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ix__url_stats
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ix__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixf_ixp_import_enabled
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ixf_ixp_import_error
in: query
description: 'Reason IX-F data could not be parsed
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixf_ixp_import_error_notified
in: query
description: 'Last time we notified the exchange about the IX-F parsing issue
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ixf_ixp_member_list_url
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixf_ixp_member_list_url_visible
in: query
description: 'Filter results by matching a value against this field.
`Private`, `Users`, `Public`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: mtu
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: rs_asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: vlan
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: integer
ix:
type: string
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its
routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add
a netixlan entry for this network via their ixp_member
data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
description: ''
/api/ixlan/{id}:
get:
operationId: retrieve ixlan
description: "Retrieves a single `ixlan` type object by id\n\n## Internet Exchange\
\ Network Information\n\nIdentified by the `ixlan` tag.\n\n### Parent relationship:\n\
\n- `ix` internet exchange\n\n### Relationship(s):\n\n- `ixpfx` prefixes\n\
- `netixlan` network to exchange connections (through ixlan)\n\n\n## Retrieve\
\ a single object\n\n### Depth\n\nNested sets will not be expanded (any field\
\ ending with the _set suffix) unless the 'depth'\nparameter is passed in\
\ the request URL.\n\nDepth can be one of three values:\n\n - 1 : expand\
\ sets into ids (slow)\n - 2 : expand sets into objects (slower)\n - 0 :\
\ dont expand sets at all (default behaviour)\n\n**example**\n\n ?depth=1\n\
\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ix_id:
type: integer
ix:
type: string
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its
routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add
a netixlan entry for this network via their ixp_member
data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
description: ''
put:
operationId: update ixlan
description: 'Updates an existing `ixlan` type object.
## Internet Exchange Network Information
Identified by the `ixlan` tag.
### Parent relationship:
- `ix` internet exchange
### Relationship(s):
- `ixpfx` prefixes
- `netixlan` network to exchange connections (through ixlan)
## Update existing objects
### Permissions
In order to update an object the requesting user requires `update` permissions
to the object itself or one of the parent relationships in the object hierarchy
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id010
properties:
ix_id:
type: integer
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
application/x-www-form-urlencoded:
schema: *id010
multipart/form-data:
schema: *id010
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ix_id:
type: integer
ix:
type: string
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its
routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add
a netixlan entry for this network via their ixp_member
data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ix_id
description: ''
/api/ixpfx:
get:
operationId: list ixpfx
description: "Retrieves a list of `ixpfx` type objects\n\n## Internet Exchange\
\ Prefix \n\nIdentified by the `ixpfx` tag.\n\n### Parent relationship:\n\n\
- `ix` internet exchange\n\n### Relationship(s):\n\n- None\n\n\n## List objects\n\
\n### Querying\n\nYou may query the resultset by passing field names as url\
\ parameters\n\n### Numeric Queries\n\nOn numeric fields you can suffix the\
\ field names with the following filters:\n\n- \\_\\_lt : less-than\n- \\\
_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n\
- \\_\\_in : value inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\n### String Queries\n\
\nOn string fields you can suffix the field names with the following filters:\n\
\n- \\_\\_contains : field value contains specified value\n- \\_\\_startswith\
\ : field value starts with specified value\n- \\_\\_in : value contained\
\ inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters:
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: in_dfz
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ix
in: query
description: 'Find prefixes by exchange (exchange id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: ixlan
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__arp_sponge
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ixlan__dot1q_support
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ixlan__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__ixf_ixp_import_enabled
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ixlan__ixf_ixp_import_error
in: query
description: 'Reason IX-F data could not be parsed
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__ixf_ixp_import_error_notified
in: query
description: 'Last time we notified the exchange about the IX-F parsing issue
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ixlan__ixf_ixp_member_list_url_visible
in: query
description: 'Filter results by matching a value against this field.
`Private`, `Users`, `Public`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__mtu
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__rs_asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ixlan__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__vlan
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: prefix
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: protocol
in: query
description: 'Filter results by matching a value against this field.
`IPv4`, `IPv6`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: whereis
in: query
description: 'Find prefixes by ip address
Filter results by matching a value against this field.'
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
ixlan:
type: string
readOnly: true
ixlan_id:
type: string
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- protocol
- prefix
description: ''
post:
operationId: create ixpfx
description: "Creates a new `ixpfx` type object.\n\n## Internet Exchange Prefix\
\ \n\nIdentified by the `ixpfx` tag.\n\n### Parent relationship:\n\n- `ix`\
\ internet exchange\n\n### Relationship(s):\n\n- None\n\n\n## Creating objects\n\
\n### Status `pending`\n\nSome object types will be flagged as `pending` until\
\ they have been reviewed and approved by peeringdb staff.\n\nCurrently this\
\ is the case for:\n\n\n- `org` organizations (only administrative staff users\
\ are currently allowed to create organizations)\n- `fac` facilities\n- `net`\
\ networks\n- `ix` exchanges\n- `ixpfx` prefixes (if part of a new exchange)\n\
- `ixlan` exchange networks (if part of a new exchange)\n\n### Permissions\n\
\nTo be able to create an object, the requesting user requires `create` permissions\
\ to one of the\nobject's parents in the relationship hierarchy.\n\nFor example\
\ to create a `net` type object, the user needs to be permissioned to create\
\ in the organzation\nthat is to be the network's holder entity.\n"
parameters: []
requestBody:
content:
application/json:
schema: &id011
properties:
ixlan_id:
type: string
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
status:
type: string
maxLength: 255
required:
- ixlan_id
- protocol
- prefix
application/x-www-form-urlencoded:
schema: *id011
multipart/form-data:
schema: *id011
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ixlan:
type: string
readOnly: true
ixlan_id:
type: string
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- protocol
- prefix
description: ''
/api/ixpfx/{id}:
get:
operationId: retrieve ixpfx
description: "Retrieves a single `ixpfx` type object by id\n\n## Internet Exchange\
\ Prefix \n\nIdentified by the `ixpfx` tag.\n\n### Parent relationship:\n\n\
- `ix` internet exchange\n\n### Relationship(s):\n\n- None\n\n\n## Retrieve\
\ a single object\n\n### Depth\n\nNested sets will not be expanded (any field\
\ ending with the _set suffix) unless the 'depth'\nparameter is passed in\
\ the request URL.\n\nDepth can be one of three values:\n\n - 1 : expand\
\ sets into ids (slow)\n - 2 : expand sets into objects (slower)\n - 0 :\
\ dont expand sets at all (default behaviour)\n\n**example**\n\n ?depth=1\n\
\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ixlan:
type: string
readOnly: true
ixlan_id:
type: string
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- protocol
- prefix
description: ''
put:
operationId: update ixpfx
description: "Updates an existing `ixpfx` type object.\n\n## Internet Exchange\
\ Prefix \n\nIdentified by the `ixpfx` tag.\n\n### Parent relationship:\n\n\
- `ix` internet exchange\n\n### Relationship(s):\n\n- None\n\n\n## Update\
\ existing objects\n\n### Permissions\n\nIn order to update an object the\
\ requesting user requires `update` permissions to the object itself or one\
\ of the parent relationships in the object hierarchy\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id012
properties:
ixlan_id:
type: string
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
status:
type: string
maxLength: 255
required:
- ixlan_id
- protocol
- prefix
application/x-www-form-urlencoded:
schema: *id012
multipart/form-data:
schema: *id012
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ixlan:
type: string
readOnly: true
ixlan_id:
type: string
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- protocol
- prefix
description: ''
patch:
operationId: patch ixpfx
description: "PATCH (partial update) is currently disabled\n\n## Internet Exchange\
\ Prefix \n\nIdentified by the `ixpfx` tag.\n\n### Parent relationship:\n\n\
- `ix` internet exchange\n\n### Relationship(s):\n\n- None\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id013
properties:
ixlan_id:
type: string
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
status:
type: string
maxLength: 255
application/x-www-form-urlencoded:
schema: *id013
multipart/form-data:
schema: *id013
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
ixlan:
type: string
readOnly: true
ixlan_id:
type: string
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- protocol
- prefix
description: ''
delete:
operationId: delete ixpfx
description: "Marks an `ixpfx` type object as `deleted`.\n\n## Internet Exchange\
\ Prefix \n\nIdentified by the `ixpfx` tag.\n\n### Parent relationship:\n\n\
- `ix` internet exchange\n\n### Relationship(s):\n\n- None\n\n\n## Deleting\
\ objects\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/net:
get:
operationId: list net
description: "Retrieves a list of `net` type objects\n\n## Network\n\nIdentified\
\ by the `net` tag.\n\n### Parent relationship:\n\n- `org` organization\n\n\
### Relationship(s):\n\n- `netixlan` network to exchange connections (through\
\ `ixlan`)\n- `netfac` network / facility presence\n- `poc` points of contact\n\
\n\n## List objects\n\n### Querying\n\nYou may query the resultset by passing\
\ field names as url parameters\n\n### Numeric Queries\n\nOn numeric fields\
\ you can suffix the field names with the following filters:\n\n- \\_\\_lt\
\ : less-than\n- \\_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n\
- \\_\\_gte : greater-than-equal\n- \\_\\_in : value inside set of values\
\ (comma separated)\n\n**examples**\n\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\
\n### String Queries\n\nOn string fields you can suffix the field names with\
\ the following filters:\n\n- \\_\\_contains : field value contains specified\
\ value\n- \\_\\_startswith : field value starts with specified value\n- \\\
_\\_in : value contained inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__contains=something\n ?<field_name>__in=this,that\n\
\nAll string filtering operations are case-insensitive\n\n### Since\n\n\n\
You can use the since argument with a unix timestamp (seconds) to retrieve\
\ all\nobjects updated since then. Note that this result will contain objects\
\ that were\ndeleted in that timeframe as well - you can spot them by checking\
\ for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\n### Nested\
\ data\n\nAny field ending in the suffix **_set** is a list of objects in\
\ a relationship with the parent\nobject, you can expand those lists with\
\ the 'depth' parameter as explained below.\n\nThe naming schema of the field\
\ will always tell you which type of object the set is holding\nand will correspond\
\ with the object's endpoint on the API\n\n <object_type>_set\n\nSo a set\
\ called 'net_set' will hold Network objects (api endpoint /net)\n\n### Depth\n\
\nNested sets will not be loaded (any field ending with the _set suffix) unless\
\ the 'depth'\nparameter is passed in the request URL.\n\nDepth can be one\
\ of three values:\n\n - 1 : expand sets into ids (slow)\n - 2 : expand\
\ sets into objects (slower)\n - 0 : dont expand sets at all (default behaviour)\n\
\n**example**\n\n ?depth=1\n\n### Cached Responses\n\nAny request that\
\ does not require lookups will be served a cached result. Cache is updated\
\ approximately every 15 minutes.\n\nYou can spot cached responses by checking\
\ for the \"generated\" property inside the \"meta\" object.\n\n \"meta\"\
\ : {\n // the cached data was last regenerated at this time (epoch)\n\
\ \"generated\" : 1456121358.6301942\n }\n\n**examples**\n\nwill\
\ serve a cached result:\n\n ?depth=2\n\nwill serve a live result:\n\n\
\ ?id__in=1,2\n\n### Resultset limit\n\nAny request that does lookup queries\
\ and has it's **depth** parameter specified will have a result limit of 250\
\ entries, any entries past this limit will be truncated, at which point you\
\ either should be more specific with your query or use the skip and limit\
\ parameters to page through the result set\n\n**examples**\n\nwill serve\
\ a live result and a maximum of 250 rows at a time:\n\n ?updated__gt=2011-01-01&depth=1\n\
\nwill serve a live result and will not be truncated:\n\n ?updated__gt=2011-01-01\n\
\nwill serve a cached result and will not be truncated:\n\n ?depth=1\n\n\
### Pagination\n\nUse the skip and limit parameters to page through results\n\
\n ?updated__gt=2011-01-01&depth=1&limit=250 - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250\
\ - second page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 -\
\ third page\n"
parameters:
- name: aka
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: allow_ixp_update
in: query
description: 'Sepcifies whether an ixp is allowed to add a netixlan entry
for this network via their ixp_member data
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: fac
in: query
description: 'Find networks present at a facility (facility id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: info_ipv6
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: info_multicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: info_never_via_route_servers
in: query
description: 'Indicates if this network will announce its routes via route
servers or not
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: info_prefixes4
in: query
description: 'Recommended IPv4 maximum-prefix limit to be configured on peering
sessions for this ASN
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: info_prefixes6
in: query
description: 'Recommended IPv6 maximum-prefix limit to be configured on peering
sessions for this ASN
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: info_ratio
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `Heavy Outbound`, `Mostly Outbound`, `Balanced`, `Mostly
Inbound`, `Heavy Inbound`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: info_scope
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `Regional`, `North America`, `Asia Pacific`, `Europe`,
`South America`, `Africa`, `Australia`, `Middle East`, `Global`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: info_traffic
in: query
description: 'Filter results by matching a value against this field.
``, `0-20Mbps`, `20-100Mbps`, `100-1000Mbps`, `1-5Gbps`, `5-10Gbps`, `10-20Gbps`,
`20-50Gbps`, `50-100Gbps`, `100-200Gbps`, `200-300Gbps`, `300-500Gbps`,
`500-1000Gbps`, `1-5Tbps`, `5-10Tbps`, `10-20Tbps`, `20-50Tbps`, `50-100Tbps`,
`100+Tbps`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: info_type
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `NSP`, `Content`, `Cable/DSL/ISP`, `Enterprise`, `Educational/Research`,
`Non-Profit`, `Route Server`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: info_unicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: irr_as_set
in: query
description: 'Reference to an AS-SET or ROUTE-SET in Internet Routing Registry
(IRR)
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ix
in: query
description: 'Find networks present at exchange (exchange id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: ixlan
in: query
description: 'Find networks connected at ixlan (ixlan id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: looking_glass
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: name_search
in: query
description: 'Targets both AKA and name fields for filtering
Filter results by matching a value against this field.'
required: false
schema:
type: string
- name: netfac
in: query
description: 'Find the network that this netfac belongs to (netfac id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: netixlan
in: query
description: 'Find the network that contains this netixlan (netixlan id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: not_fac
in: query
description: 'Find networks not present at a facility (facility id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: not_ix
in: query
description: 'Find networks not present at an exchange (exchange id)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: notes_private
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__address1
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__address2
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: org__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__state
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: org__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: org__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: org__zipcode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: policy_contracts
in: query
description: 'Filter results by matching a value against this field.
`Not Required`, `Private Only`, `Required`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: policy_general
in: query
description: 'Filter results by matching a value against this field.
`Open`, `Selective`, `Restrictive`, `No`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: policy_locations
in: query
description: 'Filter results by matching a value against this field.
`Not Required`, `Preferred`, `Required - US`, `Required - EU`, `Required
- International`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: policy_ratio
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: policy_url
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: route_server
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its routes
via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
description: ''
post:
operationId: create net
description: 'Creates a new `net` type object.
## Network
Identified by the `net` tag.
### Parent relationship:
- `org` organization
### Relationship(s):
- `netixlan` network to exchange connections (through `ixlan`)
- `netfac` network / facility presence
- `poc` points of contact
## Creating objects
### Status `pending`
Some object types will be flagged as `pending` until they have been reviewed
and approved by peeringdb staff.
Currently this is the case for:
- `org` organizations (only administrative staff users are currently allowed
to create organizations)
- `fac` facilities
- `net` networks
- `ix` exchanges
- `ixpfx` prefixes (if part of a new exchange)
- `ixlan` exchange networks (if part of a new exchange)
### Permissions
To be able to create an object, the requesting user requires `create` permissions
to one of the
object''s parents in the relationship hierarchy.
For example to create a `net` type object, the user needs to be permissioned
to create in the organzation
that is to be the network''s holder entity.
'
parameters: []
requestBody:
content:
application/json:
schema: &id014
properties:
org_id:
type: integer
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet Routing
Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its routes
via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add a netixlan
entry for this network via their ixp_member data
suggest:
type: boolean
writeOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
application/x-www-form-urlencoded:
schema: *id014
multipart/form-data:
schema: *id014
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet Routing
Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its routes
via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
description: ''
/api/net/{id}:
get:
operationId: retrieve net
description: "Retrieves a single `net` type object by id\n\n## Network\n\nIdentified\
\ by the `net` tag.\n\n### Parent relationship:\n\n- `org` organization\n\n\
### Relationship(s):\n\n- `netixlan` network to exchange connections (through\
\ `ixlan`)\n- `netfac` network / facility presence\n- `poc` points of contact\n\
\n\n## Retrieve a single object\n\n### Depth\n\nNested sets will not be expanded\
\ (any field ending with the _set suffix) unless the 'depth'\nparameter is\
\ passed in the request URL.\n\nDepth can be one of three values:\n\n - 1\
\ : expand sets into ids (slow)\n - 2 : expand sets into objects (slower)\n\
\ - 0 : dont expand sets at all (default behaviour)\n\n**example**\n\n \
\ ?depth=1\n\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet Routing
Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its routes
via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
description: ''
put:
operationId: update net
description: 'Updates an existing `net` type object.
## Network
Identified by the `net` tag.
### Parent relationship:
- `org` organization
### Relationship(s):
- `netixlan` network to exchange connections (through `ixlan`)
- `netfac` network / facility presence
- `poc` points of contact
## Update existing objects
### Permissions
In order to update an object the requesting user requires `update` permissions
to the object itself or one of the parent relationships in the object hierarchy
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id015
properties:
org_id:
type: integer
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet Routing
Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its routes
via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add a netixlan
entry for this network via their ixp_member data
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
application/x-www-form-urlencoded:
schema: *id015
multipart/form-data:
schema: *id015
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet Routing
Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its routes
via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
description: ''
patch:
operationId: patch net
description: 'PATCH (partial update) is currently disabled
## Network
Identified by the `net` tag.
### Parent relationship:
- `org` organization
### Relationship(s):
- `netixlan` network to exchange connections (through `ixlan`)
- `netfac` network / facility presence
- `poc` points of contact
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id016
properties:
org_id:
type: integer
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet Routing
Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its routes
via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add a netixlan
entry for this network via their ixp_member data
suggest:
type: boolean
writeOnly: true
status:
type: string
maxLength: 255
application/x-www-form-urlencoded:
schema: *id016
multipart/form-data:
schema: *id016
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet Routing
Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its routes
via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
description: ''
delete:
operationId: delete net
description: 'Marks an `net` type object as `deleted`.
## Network
Identified by the `net` tag.
### Parent relationship:
- `org` organization
### Relationship(s):
- `netixlan` network to exchange connections (through `ixlan`)
- `netfac` network / facility presence
- `poc` points of contact
## Deleting objects
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/poc:
get:
operationId: list poc
description: "Retrieves a list of `poc` type objects\n\n## Network Point of\
\ Contact \n\nIdentified by the `poc` tag.\n\n### Parent relationship:\n\n\
- `net` network\n\n### Relationship(s):\n\n- None \n\n\n## List objects\n\n\
### Querying\n\nYou may query the resultset by passing field names as url\
\ parameters\n\n### Numeric Queries\n\nOn numeric fields you can suffix the\
\ field names with the following filters:\n\n- \\_\\_lt : less-than\n- \\\
_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n\
- \\_\\_in : value inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\n### String Queries\n\
\nOn string fields you can suffix the field names with the following filters:\n\
\n- \\_\\_contains : field value contains specified value\n- \\_\\_startswith\
\ : field value starts with specified value\n- \\_\\_in : value contained\
\ inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters:
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__aka
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__allow_ixp_update
in: query
description: 'Sepcifies whether an ixp is allowed to add a netixlan entry
for this network via their ixp_member data
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: net__asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: net__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_ipv6
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__info_multicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__info_never_via_route_servers
in: query
description: 'Indicates if this network will announce its routes via route
servers or not
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: net__info_prefixes4
in: query
description: 'Recommended IPv4 maximum-prefix limit to be configured on peering
sessions for this ASN
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_prefixes6
in: query
description: 'Recommended IPv6 maximum-prefix limit to be configured on peering
sessions for this ASN
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_ratio
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `Heavy Outbound`, `Mostly Outbound`, `Balanced`, `Mostly
Inbound`, `Heavy Inbound`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_scope
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `Regional`, `North America`, `Asia Pacific`, `Europe`,
`South America`, `Africa`, `Australia`, `Middle East`, `Global`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_traffic
in: query
description: 'Filter results by matching a value against this field.
``, `0-20Mbps`, `20-100Mbps`, `100-1000Mbps`, `1-5Gbps`, `5-10Gbps`, `10-20Gbps`,
`20-50Gbps`, `50-100Gbps`, `100-200Gbps`, `200-300Gbps`, `300-500Gbps`,
`500-1000Gbps`, `1-5Tbps`, `5-10Tbps`, `10-20Tbps`, `20-50Tbps`, `50-100Tbps`,
`100+Tbps`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_type
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `NSP`, `Content`, `Cable/DSL/ISP`, `Enterprise`, `Educational/Research`,
`Non-Profit`, `Route Server`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_unicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__irr_as_set
in: query
description: 'Reference to an AS-SET or ROUTE-SET in Internet Routing Registry
(IRR)
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__looking_glass
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_contracts
in: query
description: 'Filter results by matching a value against this field.
`Not Required`, `Private Only`, `Required`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_general
in: query
description: 'Filter results by matching a value against this field.
`Open`, `Selective`, `Restrictive`, `No`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_locations
in: query
description: 'Filter results by matching a value against this field.
`Not Required`, `Preferred`, `Required - US`, `Required - EU`, `Required
- International`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_ratio
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__policy_url
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__route_server
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: net__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: network
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: role
in: query
description: 'Filter results by matching a value against this field.
`Abuse`, `Maintenance`, `Policy`, `Technical`, `NOC`, `Public Relations`,
`Sales`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: url
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: visible
in: query
description: 'Filter results by matching a value against this field.
`Private`, `Users`, `Public`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- role
description: ''
post:
operationId: create poc
description: "Creates a new `poc` type object.\n\n## Network Point of Contact\
\ \n\nIdentified by the `poc` tag.\n\n### Parent relationship:\n\n- `net`\
\ network\n\n### Relationship(s):\n\n- None \n\n\n## Creating objects\n\n\
### Status `pending`\n\nSome object types will be flagged as `pending` until\
\ they have been reviewed and approved by peeringdb staff.\n\nCurrently this\
\ is the case for:\n\n\n- `org` organizations (only administrative staff users\
\ are currently allowed to create organizations)\n- `fac` facilities\n- `net`\
\ networks\n- `ix` exchanges\n- `ixpfx` prefixes (if part of a new exchange)\n\
- `ixlan` exchange networks (if part of a new exchange)\n\n### Permissions\n\
\nTo be able to create an object, the requesting user requires `create` permissions\
\ to one of the\nobject's parents in the relationship hierarchy.\n\nFor example\
\ to create a `net` type object, the user needs to be permissioned to create\
\ in the organzation\nthat is to be the network's holder entity.\n"
parameters: []
requestBody:
content:
application/json:
schema: &id017
properties:
net_id:
type: integer
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
status:
type: string
maxLength: 255
required:
- net_id
- role
application/x-www-form-urlencoded:
schema: *id017
multipart/form-data:
schema: *id017
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- role
description: ''
/api/poc/{id}:
get:
operationId: retrieve poc
description: "Retrieves a single `poc` type object by id\n\n## Network Point\
\ of Contact \n\nIdentified by the `poc` tag.\n\n### Parent relationship:\n\
\n- `net` network\n\n### Relationship(s):\n\n- None \n\n\n## Retrieve a single\
\ object\n\n### Depth\n\nNested sets will not be expanded (any field ending\
\ with the _set suffix) unless the 'depth'\nparameter is passed in the request\
\ URL.\n\nDepth can be one of three values:\n\n - 1 : expand sets into ids\
\ (slow)\n - 2 : expand sets into objects (slower)\n - 0 : dont expand sets\
\ at all (default behaviour)\n\n**example**\n\n ?depth=1\n\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- role
description: ''
put:
operationId: update poc
description: "Updates an existing `poc` type object.\n\n## Network Point of\
\ Contact \n\nIdentified by the `poc` tag.\n\n### Parent relationship:\n\n\
- `net` network\n\n### Relationship(s):\n\n- None \n\n\n## Update existing\
\ objects\n\n### Permissions\n\nIn order to update an object the requesting\
\ user requires `update` permissions to the object itself or one of the parent\
\ relationships in the object hierarchy\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id018
properties:
net_id:
type: integer
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
status:
type: string
maxLength: 255
required:
- net_id
- role
application/x-www-form-urlencoded:
schema: *id018
multipart/form-data:
schema: *id018
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- role
description: ''
patch:
operationId: patch poc
description: "PATCH (partial update) is currently disabled\n\n## Network Point\
\ of Contact \n\nIdentified by the `poc` tag.\n\n### Parent relationship:\n\
\n- `net` network\n\n### Relationship(s):\n\n- None \n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id019
properties:
net_id:
type: integer
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
status:
type: string
maxLength: 255
application/x-www-form-urlencoded:
schema: *id019
multipart/form-data:
schema: *id019
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- role
description: ''
delete:
operationId: delete poc
description: "Marks an `poc` type object as `deleted`.\n\n## Network Point of\
\ Contact \n\nIdentified by the `poc` tag.\n\n### Parent relationship:\n\n\
- `net` network\n\n### Relationship(s):\n\n- None \n\n\n## Deleting objects\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/netfac:
get:
operationId: list netfac
description: "Retrieves a list of `netfac` type objects\n\n## Network / Facility\
\ presence \n\nIdentified by the `netfac` tag.\n\n### Parent relationship:\n\
\n- `net` network\n\n### Relationship(s):\n\n- `fac` facility\n\n\n## List\
\ objects\n\n### Querying\n\nYou may query the resultset by passing field\
\ names as url parameters\n\n### Numeric Queries\n\nOn numeric fields you\
\ can suffix the field names with the following filters:\n\n- \\_\\_lt : less-than\n\
- \\_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n\
- \\_\\_in : value inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\n### String Queries\n\
\nOn string fields you can suffix the field names with the following filters:\n\
\n- \\_\\_contains : field value contains specified value\n- \\_\\_startswith\
\ : field value starts with specified value\n- \\_\\_in : value contained\
\ inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters:
- name: avail_atm
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: avail_ethernet
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: avail_sonet
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: city
in: query
description: 'Facility city
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: country
in: query
description: 'Facility country
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: fac__address1
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__address2
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__clli
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: fac__geocode_date
in: query
description: 'Last time of attempted geocode
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: fac__geocode_error
in: query
description: 'Error message of previous geocode attempt
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__geocode_status
in: query
description: 'Has this object''s latitude and longitude been syncronized to
it''s address fields
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: fac__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: fac__latitude
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: number
- name: fac__longitude
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: number
- name: fac__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__npanxx
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__rencode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__sales_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__sales_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__state
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__tech_email
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__tech_phone
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: fac__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: fac__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: fac__zipcode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: facility
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: local_asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: name
in: query
description: 'Facility name
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__aka
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__allow_ixp_update
in: query
description: 'Sepcifies whether an ixp is allowed to add a netixlan entry
for this network via their ixp_member data
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: net__asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: net__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_ipv6
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__info_multicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__info_never_via_route_servers
in: query
description: 'Indicates if this network will announce its routes via route
servers or not
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: net__info_prefixes4
in: query
description: 'Recommended IPv4 maximum-prefix limit to be configured on peering
sessions for this ASN
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_prefixes6
in: query
description: 'Recommended IPv6 maximum-prefix limit to be configured on peering
sessions for this ASN
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_ratio
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `Heavy Outbound`, `Mostly Outbound`, `Balanced`, `Mostly
Inbound`, `Heavy Inbound`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_scope
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `Regional`, `North America`, `Asia Pacific`, `Europe`,
`South America`, `Africa`, `Australia`, `Middle East`, `Global`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_traffic
in: query
description: 'Filter results by matching a value against this field.
``, `0-20Mbps`, `20-100Mbps`, `100-1000Mbps`, `1-5Gbps`, `5-10Gbps`, `10-20Gbps`,
`20-50Gbps`, `50-100Gbps`, `100-200Gbps`, `200-300Gbps`, `300-500Gbps`,
`500-1000Gbps`, `1-5Tbps`, `5-10Tbps`, `10-20Tbps`, `20-50Tbps`, `50-100Tbps`,
`100+Tbps`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_type
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `NSP`, `Content`, `Cable/DSL/ISP`, `Enterprise`, `Educational/Research`,
`Non-Profit`, `Route Server`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_unicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__irr_as_set
in: query
description: 'Reference to an AS-SET or ROUTE-SET in Internet Routing Registry
(IRR)
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__looking_glass
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_contracts
in: query
description: 'Filter results by matching a value against this field.
`Not Required`, `Private Only`, `Required`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_general
in: query
description: 'Filter results by matching a value against this field.
`Open`, `Selective`, `Restrictive`, `No`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_locations
in: query
description: 'Filter results by matching a value against this field.
`Not Required`, `Preferred`, `Required - US`, `Required - EU`, `Required
- International`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_ratio
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__policy_url
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__route_server
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: net__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: network
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- fac_id
description: ''
post:
operationId: create netfac
description: "Creates a new `netfac` type object.\n\n## Network / Facility presence\
\ \n\nIdentified by the `netfac` tag.\n\n### Parent relationship:\n\n- `net`\
\ network\n\n### Relationship(s):\n\n- `fac` facility\n\n\n## Creating objects\n\
\n### Status `pending`\n\nSome object types will be flagged as `pending` until\
\ they have been reviewed and approved by peeringdb staff.\n\nCurrently this\
\ is the case for:\n\n\n- `org` organizations (only administrative staff users\
\ are currently allowed to create organizations)\n- `fac` facilities\n- `net`\
\ networks\n- `ix` exchanges\n- `ixpfx` prefixes (if part of a new exchange)\n\
- `ixlan` exchange networks (if part of a new exchange)\n\n### Permissions\n\
\nTo be able to create an object, the requesting user requires `create` permissions\
\ to one of the\nobject's parents in the relationship hierarchy.\n\nFor example\
\ to create a `net` type object, the user needs to be permissioned to create\
\ in the organzation\nthat is to be the network's holder entity.\n"
parameters: []
requestBody:
content:
application/json:
schema: &id020
properties:
net_id:
type: integer
fac_id:
type: integer
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
status:
type: string
maxLength: 255
required:
- net_id
- fac_id
application/x-www-form-urlencoded:
schema: *id020
multipart/form-data:
schema: *id020
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- fac_id
description: ''
/api/netfac/{id}:
get:
operationId: retrieve netfac
description: "Retrieves a single `netfac` type object by id\n\n## Network /\
\ Facility presence \n\nIdentified by the `netfac` tag.\n\n### Parent relationship:\n\
\n- `net` network\n\n### Relationship(s):\n\n- `fac` facility\n\n\n## Retrieve\
\ a single object\n\n### Depth\n\nNested sets will not be expanded (any field\
\ ending with the _set suffix) unless the 'depth'\nparameter is passed in\
\ the request URL.\n\nDepth can be one of three values:\n\n - 1 : expand\
\ sets into ids (slow)\n - 2 : expand sets into objects (slower)\n - 0 :\
\ dont expand sets at all (default behaviour)\n\n**example**\n\n ?depth=1\n\
\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- fac_id
description: ''
put:
operationId: update netfac
description: "Updates an existing `netfac` type object.\n\n## Network / Facility\
\ presence \n\nIdentified by the `netfac` tag.\n\n### Parent relationship:\n\
\n- `net` network\n\n### Relationship(s):\n\n- `fac` facility\n\n\n## Update\
\ existing objects\n\n### Permissions\n\nIn order to update an object the\
\ requesting user requires `update` permissions to the object itself or one\
\ of the parent relationships in the object hierarchy\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id021
properties:
net_id:
type: integer
fac_id:
type: integer
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
status:
type: string
maxLength: 255
required:
- net_id
- fac_id
application/x-www-form-urlencoded:
schema: *id021
multipart/form-data:
schema: *id021
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- fac_id
description: ''
patch:
operationId: patch netfac
description: "PATCH (partial update) is currently disabled\n\n## Network / Facility\
\ presence \n\nIdentified by the `netfac` tag.\n\n### Parent relationship:\n\
\n- `net` network\n\n### Relationship(s):\n\n- `fac` facility\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id022
properties:
net_id:
type: integer
fac_id:
type: integer
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
status:
type: string
maxLength: 255
application/x-www-form-urlencoded:
schema: *id022
multipart/form-data:
schema: *id022
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- fac_id
description: ''
delete:
operationId: delete netfac
description: "Marks an `netfac` type object as `deleted`.\n\n## Network / Facility\
\ presence \n\nIdentified by the `netfac` tag.\n\n### Parent relationship:\n\
\n- `net` network\n\n### Relationship(s):\n\n- `fac` facility\n\n\n## Deleting\
\ objects\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/netixlan:
get:
operationId: list netixlan
description: "Retrieves a list of `netixlan` type objects\n\n## Network to Internet\
\ Exchange connection \n\nIdentified by the `netixlan` tag.\n\n### Parent\
\ relationship:\n\n- `net` network\n\n### Relationship(s):\n\n- `ixlan` internet\
\ exchange network information\n\n\n## List objects\n\n### Querying\n\nYou\
\ may query the resultset by passing field names as url parameters\n\n###\
\ Numeric Queries\n\nOn numeric fields you can suffix the field names with\
\ the following filters:\n\n- \\_\\_lt : less-than\n- \\_\\_lte : less-than-equal\n\
- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n- \\_\\_in :\
\ value inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__lt=10\n\
\ ?<field_name>__in=1,10\n\n### String Queries\n\nOn string fields you\
\ can suffix the field names with the following filters:\n\n- \\_\\_contains\
\ : field value contains specified value\n- \\_\\_startswith : field value\
\ starts with specified value\n- \\_\\_in : value contained inside set of\
\ values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters:
- name: asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ipaddr4
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ipaddr6
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: is_rs_peer
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ixlan
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__arp_sponge
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ixlan__dot1q_support
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ixlan__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__ixf_ixp_import_enabled
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: ixlan__ixf_ixp_import_error
in: query
description: 'Reason IX-F data could not be parsed
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__ixf_ixp_import_error_notified
in: query
description: 'Last time we notified the exchange about the IX-F parsing issue
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ixlan__ixf_ixp_member_list_url_visible
in: query
description: 'Filter results by matching a value against this field.
`Private`, `Users`, `Public`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__mtu
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__rs_asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: ixlan__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: ixlan__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: ixlan__vlan
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: name
in: query
description: 'Exchange name
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__aka
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__allow_ixp_update
in: query
description: 'Sepcifies whether an ixp is allowed to add a netixlan entry
for this network via their ixp_member data
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: net__asn
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: net__id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_ipv6
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__info_multicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__info_never_via_route_servers
in: query
description: 'Indicates if this network will announce its routes via route
servers or not
Filter results by matching a value against this field.'
required: false
schema:
type: integer
- name: net__info_prefixes4
in: query
description: 'Recommended IPv4 maximum-prefix limit to be configured on peering
sessions for this ASN
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_prefixes6
in: query
description: 'Recommended IPv6 maximum-prefix limit to be configured on peering
sessions for this ASN
Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__info_ratio
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `Heavy Outbound`, `Mostly Outbound`, `Balanced`, `Mostly
Inbound`, `Heavy Inbound`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_scope
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `Regional`, `North America`, `Asia Pacific`, `Europe`,
`South America`, `Africa`, `Australia`, `Middle East`, `Global`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_traffic
in: query
description: 'Filter results by matching a value against this field.
``, `0-20Mbps`, `20-100Mbps`, `100-1000Mbps`, `1-5Gbps`, `5-10Gbps`, `10-20Gbps`,
`20-50Gbps`, `50-100Gbps`, `100-200Gbps`, `200-300Gbps`, `300-500Gbps`,
`500-1000Gbps`, `1-5Tbps`, `5-10Tbps`, `10-20Tbps`, `20-50Tbps`, `50-100Tbps`,
`100+Tbps`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_type
in: query
description: 'Filter results by matching a value against this field.
``, `Not Disclosed`, `NSP`, `Content`, `Cable/DSL/ISP`, `Enterprise`, `Educational/Research`,
`Non-Profit`, `Route Server`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__info_unicast
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__irr_as_set
in: query
description: 'Reference to an AS-SET or ROUTE-SET in Internet Routing Registry
(IRR)
Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__looking_glass
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_contracts
in: query
description: 'Filter results by matching a value against this field.
`Not Required`, `Private Only`, `Required`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_general
in: query
description: 'Filter results by matching a value against this field.
`Open`, `Selective`, `Restrictive`, `No`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_locations
in: query
description: 'Filter results by matching a value against this field.
`Not Required`, `Preferred`, `Required - US`, `Required - EU`, `Required
- International`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__policy_ratio
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: net__policy_url
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__route_server
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: net__updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: net__version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: net__website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: network
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: operational
in: query
description: Filter results by matching a value against this field.
required: false
schema:
type: integer
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: speed
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
description: ''
post:
operationId: create netixlan
description: "Creates a new `netixlan` type object.\n\n## Network to Internet\
\ Exchange connection \n\nIdentified by the `netixlan` tag.\n\n### Parent\
\ relationship:\n\n- `net` network\n\n### Relationship(s):\n\n- `ixlan` internet\
\ exchange network information\n\n\n## Creating objects\n\n### Status `pending`\n\
\nSome object types will be flagged as `pending` until they have been reviewed\
\ and approved by peeringdb staff.\n\nCurrently this is the case for:\n\n\n\
- `org` organizations (only administrative staff users are currently allowed\
\ to create organizations)\n- `fac` facilities\n- `net` networks\n- `ix` exchanges\n\
- `ixpfx` prefixes (if part of a new exchange)\n- `ixlan` exchange networks\
\ (if part of a new exchange)\n\n### Permissions\n\nTo be able to create an\
\ object, the requesting user requires `create` permissions to one of the\n\
object's parents in the relationship hierarchy.\n\nFor example to create a\
\ `net` type object, the user needs to be permissioned to create in the organzation\n\
that is to be the network's holder entity.\n"
parameters: []
requestBody:
content:
application/json:
schema: &id023
properties:
net_id:
type: integer
ixlan_id:
type: string
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
status:
type: string
maxLength: 255
required:
- net_id
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
application/x-www-form-urlencoded:
schema: *id023
multipart/form-data:
schema: *id023
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
description: ''
/api/netixlan/{id}:
get:
operationId: retrieve netixlan
description: "Retrieves a single `netixlan` type object by id\n\n## Network\
\ to Internet Exchange connection \n\nIdentified by the `netixlan` tag.\n\n\
### Parent relationship:\n\n- `net` network\n\n### Relationship(s):\n\n- `ixlan`\
\ internet exchange network information\n\n\n## Retrieve a single object\n\
\n### Depth\n\nNested sets will not be expanded (any field ending with the\
\ _set suffix) unless the 'depth'\nparameter is passed in the request URL.\n\
\nDepth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
description: ''
put:
operationId: update netixlan
description: "Updates an existing `netixlan` type object.\n\n## Network to Internet\
\ Exchange connection \n\nIdentified by the `netixlan` tag.\n\n### Parent\
\ relationship:\n\n- `net` network\n\n### Relationship(s):\n\n- `ixlan` internet\
\ exchange network information\n\n\n## Update existing objects\n\n### Permissions\n\
\nIn order to update an object the requesting user requires `update` permissions\
\ to the object itself or one of the parent relationships in the object hierarchy\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id024
properties:
net_id:
type: integer
ixlan_id:
type: string
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
status:
type: string
maxLength: 255
required:
- net_id
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
application/x-www-form-urlencoded:
schema: *id024
multipart/form-data:
schema: *id024
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
description: ''
patch:
operationId: patch netixlan
description: "PATCH (partial update) is currently disabled\n\n## Network to\
\ Internet Exchange connection \n\nIdentified by the `netixlan` tag.\n\n###\
\ Parent relationship:\n\n- `net` network\n\n### Relationship(s):\n\n- `ixlan`\
\ internet exchange network information\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id025
properties:
net_id:
type: integer
ixlan_id:
type: string
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
status:
type: string
maxLength: 255
application/x-www-form-urlencoded:
schema: *id025
multipart/form-data:
schema: *id025
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
net_id:
type: integer
net:
type: string
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- net_id
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
description: ''
delete:
operationId: delete netixlan
description: "Marks an `netixlan` type object as `deleted`.\n\n## Network to\
\ Internet Exchange connection \n\nIdentified by the `netixlan` tag.\n\n###\
\ Parent relationship:\n\n- `net` network\n\n### Relationship(s):\n\n- `ixlan`\
\ internet exchange network information\n\n\n## Deleting objects\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/org:
get:
operationId: list org
description: "Retrieves a list of `org` type objects\n\n## Organization\n\n\
Identified by the `org` tag.\n\nThe organization is at the top of the peeringdb\
\ object hierarchy.\n\n### Parent relationship:\n\n- None\n\n### Children\
\ relationship(s):\n\n- `net` networks\n- `fac` facilities\n- `ix` exchanges\n\
\n\n## List objects\n\n### Querying\n\nYou may query the resultset by passing\
\ field names as url parameters\n\n### Numeric Queries\n\nOn numeric fields\
\ you can suffix the field names with the following filters:\n\n- \\_\\_lt\
\ : less-than\n- \\_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n\
- \\_\\_gte : greater-than-equal\n- \\_\\_in : value inside set of values\
\ (comma separated)\n\n**examples**\n\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\
\n### String Queries\n\nOn string fields you can suffix the field names with\
\ the following filters:\n\n- \\_\\_contains : field value contains specified\
\ value\n- \\_\\_startswith : field value starts with specified value\n- \\\
_\\_in : value contained inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__contains=something\n ?<field_name>__in=this,that\n\
\nAll string filtering operations are case-insensitive\n\n### Since\n\n\n\
You can use the since argument with a unix timestamp (seconds) to retrieve\
\ all\nobjects updated since then. Note that this result will contain objects\
\ that were\ndeleted in that timeframe as well - you can spot them by checking\
\ for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\n### Nested\
\ data\n\nAny field ending in the suffix **_set** is a list of objects in\
\ a relationship with the parent\nobject, you can expand those lists with\
\ the 'depth' parameter as explained below.\n\nThe naming schema of the field\
\ will always tell you which type of object the set is holding\nand will correspond\
\ with the object's endpoint on the API\n\n <object_type>_set\n\nSo a set\
\ called 'net_set' will hold Network objects (api endpoint /net)\n\n### Depth\n\
\nNested sets will not be loaded (any field ending with the _set suffix) unless\
\ the 'depth'\nparameter is passed in the request URL.\n\nDepth can be one\
\ of three values:\n\n - 1 : expand sets into ids (slow)\n - 2 : expand\
\ sets into objects (slower)\n - 0 : dont expand sets at all (default behaviour)\n\
\n**example**\n\n ?depth=1\n\n### Cached Responses\n\nAny request that\
\ does not require lookups will be served a cached result. Cache is updated\
\ approximately every 15 minutes.\n\nYou can spot cached responses by checking\
\ for the \"generated\" property inside the \"meta\" object.\n\n \"meta\"\
\ : {\n // the cached data was last regenerated at this time (epoch)\n\
\ \"generated\" : 1456121358.6301942\n }\n\n**examples**\n\nwill\
\ serve a cached result:\n\n ?depth=2\n\nwill serve a live result:\n\n\
\ ?id__in=1,2\n\n### Resultset limit\n\nAny request that does lookup queries\
\ and has it's **depth** parameter specified will have a result limit of 250\
\ entries, any entries past this limit will be truncated, at which point you\
\ either should be more specific with your query or use the skip and limit\
\ parameters to page through the result set\n\n**examples**\n\nwill serve\
\ a live result and a maximum of 250 rows at a time:\n\n ?updated__gt=2011-01-01&depth=1\n\
\nwill serve a live result and will not be truncated:\n\n ?updated__gt=2011-01-01\n\
\nwill serve a cached result and will not be truncated:\n\n ?depth=1\n\n\
### Pagination\n\nUse the skip and limit parameters to page through results\n\
\n ?updated__gt=2011-01-01&depth=1&limit=250 - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250\
\ - second page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 -\
\ third page\n"
parameters:
- name: address1
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: address2
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: asn
in: query
description: 'Find organization that contains the network (network asn)
Filter results by matching a value against this field.'
required: false
schema:
type: number
- name: city
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: country
in: query
description: 'Filter results by matching a value against this field.
`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`,
`AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`,
`BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`,
`BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`,
`CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`,
`DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`,
`FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`,
`GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`,
`HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`,
`IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `XK`, `KW`,
`KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`,
`MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`,
`MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`,
`NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`,
`PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`,
`QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`,
`WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`,
`SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`,
`CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`,
`TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`,
`VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: created
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 0
minimum: 0
maximum: 2
- name: id
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: latitude
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: number
- name: limit
in: query
required: false
description: Limit the number of rows returned in the result set (use for
pagination in combination with `skip`)
schema:
type: integer
- name: longitude
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: number
- name: name
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: notes
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: since
in: query
required: false
description: Unix epoch time stamp (seconds). Only return objects that have
been updated since then
schema:
type: integer
- name: skip
in: query
required: false
description: Skip n results in the result set (use for pagination in combination
with `limit`)
schema:
type: integer
- name: state
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: status
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: updated
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: date-time
- name: version
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__lt`, `__gt`, `__lte`, `__gte`, `__in`'
required: false
schema:
type: integer
- name: website
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
- name: zipcode
in: query
description: 'Filter results by matching a value against this field.
Supported filter suffixes: `__startswith`, `__contains`, `__in`'
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
notes:
type: string
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its
routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add
a netixlan entry for this network via their ixp_member
data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- asn
readOnly: true
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_name:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- name
- website
- address1
- city
- zipcode
readOnly: true
ix_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET
in Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will
announce its routes via route servers or
not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF\
0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed
to add a netixlan entry for this network
via their ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
suggest:
type: boolean
writeOnly: true
prefix:
type: string
writeOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- city
- country
- region_continent
- media
- website
- tech_email
readOnly: true
address1:
type: string
maxLength: 255
address2:
type: string
maxLength: 255
city:
type: string
maxLength: 255
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
maxLength: 48
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
description: ''
post:
operationId: create org
description: 'Creates a new `org` type object.
## Organization
Identified by the `org` tag.
The organization is at the top of the peeringdb object hierarchy.
### Parent relationship:
- None
### Children relationship(s):
- `net` networks
- `fac` facilities
- `ix` exchanges
## Creating objects
### Status `pending`
Some object types will be flagged as `pending` until they have been reviewed
and approved by peeringdb staff.
Currently this is the case for:
- `org` organizations (only administrative staff users are currently allowed
to create organizations)
- `fac` facilities
- `net` networks
- `ix` exchanges
- `ixpfx` prefixes (if part of a new exchange)
- `ixlan` exchange networks (if part of a new exchange)
### Permissions
To be able to create an object, the requesting user requires `create` permissions
to one of the
object''s parents in the relationship hierarchy.
For example to create a `net` type object, the user needs to be permissioned
to create in the organzation
that is to be the network''s holder entity.
'
parameters: []
requestBody:
content:
application/json:
schema: &id026
properties:
name:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
notes:
type: string
address1:
type: string
maxLength: 255
address2:
type: string
maxLength: 255
city:
type: string
maxLength: 255
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
maxLength: 48
status:
type: string
maxLength: 255
required:
- name
application/x-www-form-urlencoded:
schema: *id026
multipart/form-data:
schema: *id026
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
notes:
type: string
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its
routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add
a netixlan entry for this network via their ixp_member
data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- asn
readOnly: true
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_name:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- name
- website
- address1
- city
- zipcode
readOnly: true
ix_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET
in Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will
announce its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\\
.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed
to add a netixlan entry for this network via
their ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
suggest:
type: boolean
writeOnly: true
prefix:
type: string
writeOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- city
- country
- region_continent
- media
- website
- tech_email
readOnly: true
address1:
type: string
maxLength: 255
address2:
type: string
maxLength: 255
city:
type: string
maxLength: 255
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
maxLength: 48
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
description: ''
/api/org/{id}:
get:
operationId: retrieve org
description: "Retrieves a single `org` type object by id\n\n## Organization\n\
\nIdentified by the `org` tag.\n\nThe organization is at the top of the peeringdb\
\ object hierarchy.\n\n### Parent relationship:\n\n- None\n\n### Children\
\ relationship(s):\n\n- `net` networks\n- `fac` facilities\n- `ix` exchanges\n\
\n\n## Retrieve a single object\n\n### Depth\n\nNested sets will not be expanded\
\ (any field ending with the _set suffix) unless the 'depth'\nparameter is\
\ passed in the request URL.\n\nDepth can be one of three values:\n\n - 1\
\ : expand sets into ids (slow)\n - 2 : expand sets into objects (slower)\n\
\ - 0 : dont expand sets at all (default behaviour)\n\n**example**\n\n \
\ ?depth=1\n\n\n"
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
- name: depth
in: query
required: false
description: Expand nested sets according to depth.
schema:
type: integer
default: 1
minimum: 0
maximum: 2
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
notes:
type: string
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its
routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add
a netixlan entry for this network via their ixp_member
data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- asn
readOnly: true
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_name:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- name
- website
- address1
- city
- zipcode
readOnly: true
ix_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET
in Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will
announce its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\\
.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed
to add a netixlan entry for this network via
their ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
suggest:
type: boolean
writeOnly: true
prefix:
type: string
writeOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- city
- country
- region_continent
- media
- website
- tech_email
readOnly: true
address1:
type: string
maxLength: 255
address2:
type: string
maxLength: 255
city:
type: string
maxLength: 255
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
maxLength: 48
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
description: ''
put:
operationId: update org
description: 'Updates an existing `org` type object.
## Organization
Identified by the `org` tag.
The organization is at the top of the peeringdb object hierarchy.
### Parent relationship:
- None
### Children relationship(s):
- `net` networks
- `fac` facilities
- `ix` exchanges
## Update existing objects
### Permissions
In order to update an object the requesting user requires `update` permissions
to the object itself or one of the parent relationships in the object hierarchy
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id027
properties:
name:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
notes:
type: string
address1:
type: string
maxLength: 255
address2:
type: string
maxLength: 255
city:
type: string
maxLength: 255
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
maxLength: 48
status:
type: string
maxLength: 255
required:
- name
application/x-www-form-urlencoded:
schema: *id027
multipart/form-data:
schema: *id027
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
notes:
type: string
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its
routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add
a netixlan entry for this network via their ixp_member
data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- asn
readOnly: true
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_name:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- name
- website
- address1
- city
- zipcode
readOnly: true
ix_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET
in Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will
announce its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\\
.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed
to add a netixlan entry for this network via
their ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
suggest:
type: boolean
writeOnly: true
prefix:
type: string
writeOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- city
- country
- region_continent
- media
- website
- tech_email
readOnly: true
address1:
type: string
maxLength: 255
address2:
type: string
maxLength: 255
city:
type: string
maxLength: 255
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
maxLength: 48
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
description: ''
patch:
operationId: patch org
description: 'PATCH (partial update) is currently disabled
## Organization
Identified by the `org` tag.
The organization is at the top of the peeringdb object hierarchy.
### Parent relationship:
- None
### Children relationship(s):
- `net` networks
- `fac` facilities
- `ix` exchanges
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: &id028
properties:
name:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
notes:
type: string
address1:
type: string
maxLength: 255
address2:
type: string
maxLength: 255
city:
type: string
maxLength: 255
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
maxLength: 48
status:
type: string
maxLength: 255
application/x-www-form-urlencoded:
schema: *id028
multipart/form-data:
schema: *id028
responses:
'200':
content:
application/json:
schema:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
notes:
type: string
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET in Internet
Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will announce its
routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed to add
a netixlan entry for this network via their ixp_member
data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- asn
readOnly: true
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_name:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- name
- website
- address1
- city
- zipcode
readOnly: true
ix_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 64
name_long:
type: string
maxLength: 254
city:
type: string
maxLength: 192
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
region_continent:
enum:
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
media:
enum:
- Ethernet
- ATM
- Multiple
notes:
type: string
proto_unicast:
type: boolean
proto_multicast:
type: boolean
proto_ipv6:
type: boolean
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
url_stats:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
tech_email:
type: string
format: email
tech_phone:
type: string
policy_email:
type: string
format: email
maxLength: 254
policy_phone:
type: string
fac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org_name:
type: string
readOnly: true
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
website:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
clli:
type: string
maxLength: 18
rencode:
type: string
maxLength: 18
npanxx:
type: string
maxLength: 21
notes:
type: string
net_count:
type: string
readOnly: true
latitude:
type: number
readOnly: true
longitude:
type: number
readOnly: true
suggest:
type: boolean
writeOnly: true
sales_email:
type: string
format: email
maxLength: 254
sales_phone:
type: string
tech_email:
type: string
format: email
maxLength: 254
tech_phone:
type: string
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
address1:
type: string
address2:
type: string
maxLength: 255
city:
type: string
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
required:
- org_id
- name
- website
- address1
- city
- zipcode
readOnly: true
ixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 255
descr:
type: string
mtu:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
dot1q_support:
type: boolean
rs_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
arp_sponge:
type: string
nullable: true
pattern: (?i)^([0-9a-f]{2}[-:]){5}[0-9a-f]{2}$
net_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
org_id:
type: integer
org:
type: string
readOnly: true
name:
type: string
maxLength: 255
aka:
type: string
maxLength: 255
website:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
looking_glass:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
route_server:
type: string
format: uri
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
irr_as_set:
type: string
description: Reference to an AS-SET or ROUTE-SET
in Internet Routing Registry (IRR)
maxLength: 255
info_type:
enum:
- ''
- Not Disclosed
- NSP
- Content
- Cable/DSL/ISP
- Enterprise
- Educational/Research
- Non-Profit
- Route Server
info_prefixes4:
type: integer
info_prefixes6:
type: integer
info_traffic:
enum:
- ''
- 0-20Mbps
- 20-100Mbps
- 100-1000Mbps
- 1-5Gbps
- 5-10Gbps
- 10-20Gbps
- 20-50Gbps
- 50-100Gbps
- 100-200Gbps
- 200-300Gbps
- 300-500Gbps
- 500-1000Gbps
- 1-5Tbps
- 5-10Tbps
- 10-20Tbps
- 20-50Tbps
- 50-100Tbps
- 100+Tbps
info_ratio:
enum:
- ''
- Not Disclosed
- Heavy Outbound
- Mostly Outbound
- Balanced
- Mostly Inbound
- Heavy Inbound
info_scope:
enum:
- ''
- Not Disclosed
- Regional
- North America
- Asia Pacific
- Europe
- South America
- Africa
- Australia
- Middle East
- Global
info_unicast:
type: boolean
info_multicast:
type: boolean
info_ipv6:
type: boolean
info_never_via_route_servers:
type: boolean
description: Indicates if this network will
announce its routes via route servers or not
notes:
type: string
policy_url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1\
-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
Z"
policy_general:
enum:
- Open
- Selective
- Restrictive
- 'No'
policy_locations:
enum:
- Not Required
- Preferred
- Required - US
- Required - EU
- Required - International
policy_ratio:
type: boolean
policy_contracts:
enum:
- Not Required
- Private Only
- Required
netfac_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
name:
type: string
readOnly: true
city:
type: string
readOnly: true
country:
type: string
readOnly: true
fac_id:
type: integer
fac:
type: string
readOnly: true
local_asn:
type: integer
maximum: 4294967295
format: int64
nullable: true
minimum: 0
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- fac_id
readOnly: true
netixlan_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
ix_id:
type: string
readOnly: true
name:
type: string
readOnly: true
ixlan_id:
type: string
ixlan:
type: string
readOnly: true
notes:
type: string
maxLength: 255
speed:
type: integer
maximum: 4294967295
format: int64
minimum: 0
asn:
type: integer
maximum: 4294967295
format: int64
minimum: 0
ipaddr4:
type: string
ipaddr6:
type: string
is_rs_peer:
type: boolean
operational:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- ixlan_id
- speed
- asn
- ipaddr4
- ipaddr6
readOnly: true
poc_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
role:
enum:
- Abuse
- Maintenance
- Policy
- Technical
- NOC
- Public Relations
- Sales
visible:
enum:
- Private
- Users
- Public
name:
type: string
maxLength: 254
phone:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 254
url:
type: string
format: uri
maxLength: 255
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\\
s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\\
]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF\
0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\\
.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
.(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
.?|localhost))(?::\\d{2,5})?(?:[/?#][^\\\
s]*)?\\Z"
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- role
readOnly: true
allow_ixp_update:
type: boolean
writeOnly: true
description: Sepcifies whether an ixp is allowed
to add a netixlan entry for this network via
their ixp_member data
suggest:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- org_id
- name
- asn
readOnly: true
ixpfx_set:
type: array
items:
properties:
id:
type: integer
readOnly: true
protocol:
enum:
- IPv4
- IPv6
prefix:
type: string
in_dfz:
type: boolean
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- protocol
- prefix
readOnly: true
ixf_ixp_member_list_url:
type: string
format: uri
nullable: true
maxLength: 200
pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1-\uFFFF\
-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
d{2,5})?(?:[/?#][^\\s]*)?\\Z"
ixf_ixp_member_list_url_visible:
enum:
- Private
- Users
- Public
ixf_ixp_import_enabled:
type: boolean
writeOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
readOnly: true
suggest:
type: boolean
writeOnly: true
prefix:
type: string
writeOnly: true
net_count:
type: string
readOnly: true
ixf_net_count:
type: integer
readOnly: true
ixf_last_import:
type: string
format: date-time
readOnly: true
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
- city
- country
- region_continent
- media
- website
- tech_email
readOnly: true
address1:
type: string
maxLength: 255
address2:
type: string
maxLength: 255
city:
type: string
maxLength: 255
country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- XK
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
state:
type: string
maxLength: 255
zipcode:
type: string
maxLength: 48
created:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
status:
type: string
maxLength: 255
required:
- name
description: ''
delete:
operationId: delete org
description: 'Marks an `org` type object as `deleted`.
## Organization
Identified by the `org` tag.
The organization is at the top of the peeringdb object hierarchy.
### Parent relationship:
- None
### Children relationship(s):
- `net` networks
- `fac` facilities
- `ix` exchanges
## Deleting objects
'
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/api/as_set:
get:
operationId: lists
description: "AS-SET endpoint\n\nlists all as sets mapped by asn\n\n## List\
\ objects\n\n### Querying\n\nYou may query the resultset by passing field\
\ names as url parameters\n\n### Numeric Queries\n\nOn numeric fields you\
\ can suffix the field names with the following filters:\n\n- \\_\\_lt : less-than\n\
- \\_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n\
- \\_\\_in : value inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\n### String Queries\n\
\nOn string fields you can suffix the field names with the following filters:\n\
\n- \\_\\_contains : field value contains specified value\n- \\_\\_startswith\
\ : field value starts with specified value\n- \\_\\_in : value contained\
\ inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties: {}
description: ''
/api/as_set/{asn}:
get:
operationId: retrieve
description: "AS-SET endpoint\n\nlists all as sets mapped by asn\n\n## List\
\ objects\n\n### Querying\n\nYou may query the resultset by passing field\
\ names as url parameters\n\n### Numeric Queries\n\nOn numeric fields you\
\ can suffix the field names with the following filters:\n\n- \\_\\_lt : less-than\n\
- \\_\\_lte : less-than-equal\n- \\_\\_gt : greater-than\n- \\_\\_gte : greater-than-equal\n\
- \\_\\_in : value inside set of values (comma separated)\n\n**examples**\n\
\n ?<field_name>__lt=10\n ?<field_name>__in=1,10\n\n### String Queries\n\
\nOn string fields you can suffix the field names with the following filters:\n\
\n- \\_\\_contains : field value contains specified value\n- \\_\\_startswith\
\ : field value starts with specified value\n- \\_\\_in : value contained\
\ inside set of values (comma separated)\n\n**examples**\n\n ?<field_name>__contains=something\n\
\ ?<field_name>__in=this,that\n\nAll string filtering operations are case-insensitive\n\
\n### Since\n\n\nYou can use the since argument with a unix timestamp (seconds)\
\ to retrieve all\nobjects updated since then. Note that this result will\
\ contain objects that were\ndeleted in that timeframe as well - you can spot\
\ them by checking for status \"deleted\"\n\n**example**\n\n ?since=1443414678\n\
\n### Nested data\n\nAny field ending in the suffix **_set** is a list of\
\ objects in a relationship with the parent\nobject, you can expand those\
\ lists with the 'depth' parameter as explained below.\n\nThe naming schema\
\ of the field will always tell you which type of object the set is holding\n\
and will correspond with the object's endpoint on the API\n\n <object_type>_set\n\
\nSo a set called 'net_set' will hold Network objects (api endpoint /net)\n\
\n### Depth\n\nNested sets will not be loaded (any field ending with the _set\
\ suffix) unless the 'depth'\nparameter is passed in the request URL.\n\n\
Depth can be one of three values:\n\n - 1 : expand sets into ids (slow)\n\
\ - 2 : expand sets into objects (slower)\n - 0 : dont expand sets at all\
\ (default behaviour)\n\n**example**\n\n ?depth=1\n\n### Cached Responses\n\
\nAny request that does not require lookups will be served a cached result.\
\ Cache is updated approximately every 15 minutes.\n\nYou can spot cached\
\ responses by checking for the \"generated\" property inside the \"meta\"\
\ object.\n\n \"meta\" : {\n // the cached data was last regenerated\
\ at this time (epoch)\n \"generated\" : 1456121358.6301942\n }\n\
\n**examples**\n\nwill serve a cached result:\n\n ?depth=2\n\nwill serve\
\ a live result:\n\n ?id__in=1,2\n\n### Resultset limit\n\nAny request\
\ that does lookup queries and has it's **depth** parameter specified will\
\ have a result limit of 250 entries, any entries past this limit will be\
\ truncated, at which point you either should be more specific with your query\
\ or use the skip and limit parameters to page through the result set\n\n\
**examples**\n\nwill serve a live result and a maximum of 250 rows at a time:\n\
\n ?updated__gt=2011-01-01&depth=1\n\nwill serve a live result and will\
\ not be truncated:\n\n ?updated__gt=2011-01-01\n\nwill serve a cached\
\ result and will not be truncated:\n\n ?depth=1\n\n### Pagination\n\n\
Use the skip and limit parameters to page through results\n\n ?updated__gt=2011-01-01&depth=1&limit=250\
\ - first page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=250 - second\
\ page\n ?updated__gt=2011-01-01&depth=1&limit=250&skip=500 - third page\n"
parameters:
- name: asn
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties: {}
description: ''
View Git Blame Copy Permalink