Sign in

v50

latestOpenAPI 3.0.0Commercialraw.githubusercontent.com2022-08-0911645127.8 KB
Account

Create a new organization

put/account/orgs

Request body

namestring
descriptionstring
export_tokenstring
projectstring boolean
parent_idstring uuid
expiration_assets_stalestring number
expiration_assets_offlinestring number
expiration_scansstring number

Example request

{
  "name": "My Organization",
  "description": "Wobbly Widgets, Inc.",
  "export_token": "ETXXXXXXXXXXXXXXXX",
  "parent_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "expiration_assets_stale": "365",
  "expiration_assets_offline": "365",
  "expiration_scans": "365"
}

Response

organization details

idstring uuid required
created_atinteger
updated_atinteger
client_idstring uuid
download_tokenstring
download_token_created_atinteger
permanentboolean
namestring required
descriptionstring
inactiveboolean
deactivated_atinteger
service_countinteger
service_count_tcpinteger
service_count_udpinteger
service_count_arpinteger
service_count_icmpinteger
asset_countinteger
export_tokenstring
export_token_created_atinteger
export_token_last_used_atinteger
export_token_last_used_bystring
export_token_counterinteger
projectboolean
parent_idstring uuid
expiration_assets_staleinteger
expiration_assets_offlineinteger
expiration_scansinteger

Example response

{
  "id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "created_at": 1576300370,
  "updated_at": 1576300370,
  "client_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "download_token": "DT11226D9EEEA2B035D42569585900",
  "download_token_created_at": 1576300370,
  "permanent": true,
  "name": "My Company",
  "description": "All subdivisions of my company",
  "service_count": 10,
  "service_count_tcp": 7,
  "service_count_udp": 1,
  "service_count_arp": 1,
  "service_count_icmp": 1,
  "asset_count": 100,
  "export_token": "ET11226D9EEEA2B035D42569585900",
  "export_token_created_at": 1576300370,
  "export_token_last_used_by": "127.0.0.1",
  "parent_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "expiration_assets_stale": 365,
  "expiration_assets_offline": 365,
  "expiration_scans": 365
}