SCscanopy
Ports

Create port

Changed on
post/api/v1/ports

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/ports
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Request body

numberinteger required

TCP or UDP port number

protocol'Udp' | 'Tcp' required

Transport protocol the port is open on.

type'Ssh' | 'Telnet' | 'DnsUdp' | 'DnsTcp' | 'Samba' | 'Nfs' | 'Ftp' | 'Ipp' | 'LdpTcp' | 'LdpUdp' | 'Ldap' | 'Ldaps' | 'Kerberos' | 'Snmp' | 'SnmpAlt' | 'Rdp' | 'Ntp' | 'Sip' | 'SipTls' | 'Rtsp' | 'Dhcp' | 'Http' | 'MySql' | 'PostgreSQL' | 'MongoDB' | 'Redis' | 'MsSql' | 'Docker' | 'DockerTls' | 'Kubernetes' | 'RabbitMqMgmt' | 'Cassandra' | 'Elasticsearch' | 'InfluxDb' | 'CouchDb' | 'Kafka' | 'Http3000' | 'Http5000' | 'Http8080' | 'Http8081' | 'Http8082' | 'Http8888' | 'Http9000' | 'Https' | 'Https8443' | 'Https9443' | 'Https10443' | 'Mqtt' | 'MqttTls' | 'AMQP' | 'AMQPTls' | 'Wireguard' | 'OpenVPN' | 'BACnet' | 'ModbusTcp' | 'OpcUa' | 'EtherNetIp' | 'JetDirect' | 'Custom'

Well-known port identifier. Auto-derived from number+protocol, so it is optional on create.

host_idstring uuid required

The host this entity belongs to.

site_idstring uuid required

The site this entity belongs to.

created_atstring date-time required

When this record was first created.

first_discovery_idstring uuid nullable

The discovery that first observed this entity.

idstring uuid required

Server-assigned unique identifier.

last_discovery_idstring uuid nullable

The most recent discovery that observed this entity.

last_seen_atstring date-time

When a discovery last observed this entity.

lineage_idstring uuid nullable

Stable identifier shared by every revision of the same entity across its history.

updated_atstring date-time required

When this record was last modified.

valid_fromstring date-time

Start of the interval this revision was current for (SCD2 history).

valid_tostring date-time nullable

End of the interval this revision was current for. null while it is the live revision.

Example request

{
  "created_at": "2026-01-15T10:30:00Z",
  "first_discovery_id": null,
  "host_id": "550e8400-e29b-41d4-a716-446655440003",
  "id": "550e8400-e29b-41d4-a716-446655440006",
  "last_discovery_id": null,
  "last_seen_at": "2026-01-15T10:30:00Z",
  "lineage_id": null,
  "number": 80,
  "port_source": "PortScan",
  "protocol": "Tcp",
  "site_id": "550e8400-e29b-41d4-a716-446655440002",
  "type": "Http",
  "updated_at": "2026-01-15T10:30:00Z",
  "valid_from": "2026-01-15T10:30:00Z",
  "valid_to": null
}

Response

Port created successfully

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "data": {
    "created_at": "2026-01-15T10:30:00Z",
    "first_discovery_id": null,
    "host_id": "550e8400-e29b-41d4-a716-446655440003",
    "id": "550e8400-e29b-41d4-a716-446655440006",
    "last_discovery_id": null,
    "last_seen_at": "2026-01-15T10:30:00Z",
    "lineage_id": null,
    "number": 80,
    "port_source": "PortScan",
    "protocol": "Tcp",
    "site_id": "550e8400-e29b-41d4-a716-446655440002",
    "type": "Http",
    "updated_at": "2026-01-15T10:30:00Z",
    "valid_from": "2026-01-15T10:30:00Z",
    "valid_to": null
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • c94279effef3Revision changes
    • warning

      added the new Lpd enum value to the //////// response property for the response status

    • warning

      added the new Lpd enum value to the //////// response property for the response status

    • info

      added the new Lpd enum value to the request property ///////

    • info

      added the new Lpd enum value to the request property ///////

  • c2ab03503a27Revision changes
    • breaking

      added subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 to the ////// response property oneOf list for the response status

    • info

      added subschema #11 subschema #12 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 to the ///// request property oneOf list