API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Magic Transit

ModelsExpand Collapse

type HealthCheck struct{…}

Enabled booloptional

Determines whether to run healthchecks for a tunnel.

Rate HealthCheckRateoptional

How frequent the health check is run. The default value is mid.

Target HealthCheckTargetUnionoptional

The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to customer_gre_endpoint address. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.

One of the following:

type HealthCheckTargetMagicHealthCheckTarget struct{…}

The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to customer_gre_endpoint address. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.

Effective stringoptional

The effective health check target. If 'saved' is empty, then this field will be populated with the calculated default value on GET requests. Ignored in POST, PUT, and PATCH requests.

Saved stringoptional

The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used.

UnionString

Type HealthCheckTypeoptional

The type of healthcheck to run, reply or request. The default value is reply.

type HealthCheckRate string

How frequent the health check is run. The default value is mid.

One of the following:

const HealthCheckRateLow HealthCheckRate = "low"

const HealthCheckRateMid HealthCheckRate = "mid"

const HealthCheckRateHigh HealthCheckRate = "high"

type HealthCheckType string

The type of healthcheck to run, reply or request. The default value is reply.

One of the following:

const HealthCheckTypeReply HealthCheckType = "reply"

const HealthCheckTypeRequest HealthCheckType = "request"

Magic TransitApps

List Apps

client.MagicTransit.Apps.List(ctx, query) (*SinglePage[AppListResponse], error)

GET/accounts/{account_id}/magic/apps

Create a new App

client.MagicTransit.Apps.New(ctx, params) (*AppNewResponse, error)

POST/accounts/{account_id}/magic/apps

Update an App

client.MagicTransit.Apps.Update(ctx, accountAppID, params) (*AppUpdateResponse, error)

PUT/accounts/{account_id}/magic/apps/{account_app_id}

Update an App

client.MagicTransit.Apps.Edit(ctx, accountAppID, params) (*AppEditResponse, error)

PATCH/accounts/{account_id}/magic/apps/{account_app_id}

Delete Account App

client.MagicTransit.Apps.Delete(ctx, accountAppID, body) (*AppDeleteResponse, error)

DELETE/accounts/{account_id}/magic/apps/{account_app_id}

Magic TransitCf Interconnects

List interconnects

client.MagicTransit.CfInterconnects.List(ctx, params) (*CfInterconnectListResponse, error)

GET/accounts/{account_id}/magic/cf_interconnects

List interconnect Details

client.MagicTransit.CfInterconnects.Get(ctx, cfInterconnectID, params) (*CfInterconnectGetResponse, error)

GET/accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}

Update interconnect

client.MagicTransit.CfInterconnects.Update(ctx, cfInterconnectID, params) (*CfInterconnectUpdateResponse, error)

PUT/accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}

Update multiple interconnects

client.MagicTransit.CfInterconnects.BulkUpdate(ctx, params) (*CfInterconnectBulkUpdateResponse, error)

PUT/accounts/{account_id}/magic/cf_interconnects

Magic TransitGRE Tunnels

List GRE tunnels

client.MagicTransit.GRETunnels.List(ctx, params) (*GRETunnelListResponse, error)

GET/accounts/{account_id}/magic/gre_tunnels

List GRE Tunnel Details

client.MagicTransit.GRETunnels.Get(ctx, greTunnelID, params) (*GRETunnelGetResponse, error)

GET/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}

Create a GRE tunnel

client.MagicTransit.GRETunnels.New(ctx, params) (*GRETunnelNewResponse, error)

POST/accounts/{account_id}/magic/gre_tunnels

Update GRE Tunnel

client.MagicTransit.GRETunnels.Update(ctx, greTunnelID, params) (*GRETunnelUpdateResponse, error)

PUT/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}

Delete GRE Tunnel

client.MagicTransit.GRETunnels.Delete(ctx, greTunnelID, params) (*GRETunnelDeleteResponse, error)

DELETE/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}

Update multiple GRE tunnels

client.MagicTransit.GRETunnels.BulkUpdate(ctx, params) (*GRETunnelBulkUpdateResponse, error)

PUT/accounts/{account_id}/magic/gre_tunnels

Magic TransitIPSEC Tunnels

List IPsec tunnels

client.MagicTransit.IPSECTunnels.List(ctx, params) (*IPSECTunnelListResponse, error)

GET/accounts/{account_id}/magic/ipsec_tunnels

List IPsec tunnel details

client.MagicTransit.IPSECTunnels.Get(ctx, ipsecTunnelID, params) (*IPSECTunnelGetResponse, error)

GET/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}

Create an IPsec tunnel

client.MagicTransit.IPSECTunnels.New(ctx, params) (*IPSECTunnelNewResponse, error)

POST/accounts/{account_id}/magic/ipsec_tunnels

Update IPsec Tunnel

client.MagicTransit.IPSECTunnels.Update(ctx, ipsecTunnelID, params) (*IPSECTunnelUpdateResponse, error)

PUT/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}

Delete IPsec Tunnel

client.MagicTransit.IPSECTunnels.Delete(ctx, ipsecTunnelID, params) (*IPSECTunnelDeleteResponse, error)

DELETE/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}

Update multiple IPsec tunnels

client.MagicTransit.IPSECTunnels.BulkUpdate(ctx, params) (*IPSECTunnelBulkUpdateResponse, error)

PUT/accounts/{account_id}/magic/ipsec_tunnels

Generate Pre Shared Key (PSK) for IPsec tunnels

client.MagicTransit.IPSECTunnels.PSKGenerate(ctx, ipsecTunnelID, params) (*IPSECTunnelPSKGenerateResponse, error)

POST/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}/psk_generate

ModelsExpand Collapse

type PSKMetadata struct{…}

The PSK metadata that includes when the PSK was generated.

LastGeneratedOn Timeoptional

The date and time the tunnel was last modified.

formatdate-time

Magic TransitRoutes

List Routes

client.MagicTransit.Routes.List(ctx, query) (*RouteListResponse, error)

GET/accounts/{account_id}/magic/routes

Route Details

client.MagicTransit.Routes.Get(ctx, routeID, query) (*RouteGetResponse, error)

GET/accounts/{account_id}/magic/routes/{route_id}

Create a Route

client.MagicTransit.Routes.New(ctx, params) (*RouteNewResponse, error)

POST/accounts/{account_id}/magic/routes

Update Route

client.MagicTransit.Routes.Update(ctx, routeID, params) (*RouteUpdateResponse, error)

PUT/accounts/{account_id}/magic/routes/{route_id}

Delete Route

client.MagicTransit.Routes.Delete(ctx, routeID, body) (*RouteDeleteResponse, error)

DELETE/accounts/{account_id}/magic/routes/{route_id}

Update Many Routes

client.MagicTransit.Routes.BulkUpdate(ctx, params) (*RouteBulkUpdateResponse, error)

PUT/accounts/{account_id}/magic/routes

Delete Many Routes

client.MagicTransit.Routes.Empty(ctx, body) (*RouteEmptyResponse, error)

DELETE/accounts/{account_id}/magic/routes

ModelsExpand Collapse

type Scope struct{…}

Used only for ECMP routes.

ColoNames []stringoptional

List of colo names for the ECMP scope.

ColoRegions []stringoptional

List of colo regions for the ECMP scope.

Magic TransitSites

List Sites

client.MagicTransit.Sites.List(ctx, params) (*SinglePage[Site], error)

GET/accounts/{account_id}/magic/sites

Site Details

client.MagicTransit.Sites.Get(ctx, siteID, params) (*Site, error)

GET/accounts/{account_id}/magic/sites/{site_id}

Create a new Site

client.MagicTransit.Sites.New(ctx, params) (*Site, error)

POST/accounts/{account_id}/magic/sites

Update Site

client.MagicTransit.Sites.Update(ctx, siteID, params) (*Site, error)

PUT/accounts/{account_id}/magic/sites/{site_id}

Patch Site

client.MagicTransit.Sites.Edit(ctx, siteID, params) (*Site, error)

PATCH/accounts/{account_id}/magic/sites/{site_id}

Delete Site

client.MagicTransit.Sites.Delete(ctx, siteID, body) (*Site, error)

DELETE/accounts/{account_id}/magic/sites/{site_id}

ModelsExpand Collapse

type Site struct{…}

ID stringoptional

Identifier

maxLength32

ConnectorID stringoptional

Magic Connector identifier tag.

Description stringoptional

HaMode booloptional

Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.

Location SiteLocationoptional

Location of site in latitude and longitude.

Name stringoptional

The name of the site.

SecondaryConnectorID stringoptional

Magic Connector identifier tag. Used when high availability mode is on.

type SiteLocation struct{…}

Location of site in latitude and longitude.

Lat stringoptional

Latitude

Lon stringoptional

Longitude

Magic TransitSitesApp Configuration

Magic TransitSitesACLs

List Site ACLs

client.MagicTransit.Sites.ACLs.List(ctx, siteID, query) (*SinglePage[ACL], error)

GET/accounts/{account_id}/magic/sites/{site_id}/acls

Site ACL Details

client.MagicTransit.Sites.ACLs.Get(ctx, siteID, aclID, query) (*ACL, error)

GET/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}

Create a new Site ACL

client.MagicTransit.Sites.ACLs.New(ctx, siteID, params) (*ACL, error)

POST/accounts/{account_id}/magic/sites/{site_id}/acls

Update Site ACL

client.MagicTransit.Sites.ACLs.Update(ctx, siteID, aclID, params) (*ACL, error)

PUT/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}

Patch Site ACL

client.MagicTransit.Sites.ACLs.Edit(ctx, siteID, aclID, params) (*ACL, error)

PATCH/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}

Delete Site ACL

client.MagicTransit.Sites.ACLs.Delete(ctx, siteID, aclID, body) (*ACL, error)

DELETE/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}

ModelsExpand Collapse

type ACL struct{…}

Bidirectional ACL policy for network traffic within a site.

ID stringoptional

Identifier

maxLength32

Description stringoptional

Description for the ACL.

ForwardLocally booloptional

The desired forwarding action for this ACL policy. If set to "false", the policy will forward traffic to Cloudflare. If set to "true", the policy will forward traffic locally on the Magic Connector. If not included in request, will default to false.

LAN1 ACLConfigurationoptional

LAN2 ACLConfigurationoptional

Name stringoptional

The name of the ACL.

Protocols []AllowedProtocoloptional

One of the following:

const AllowedProtocolTCP AllowedProtocol = "tcp"

const AllowedProtocolUdp AllowedProtocol = "udp"

const AllowedProtocolIcmp AllowedProtocol = "icmp"

Unidirectional booloptional

The desired traffic direction for this ACL policy. If set to "false", the policy will allow bidirectional traffic. If set to "true", the policy will only allow traffic in one direction. If not included in request, will default to false.

type ACLConfiguration struct{…}

LANID string

The identifier for the LAN you want to create an ACL policy with.

LANName stringoptional

The name of the LAN based on the provided lan_id.

PortRanges []stringoptional

Array of port ranges on the provided LAN that will be included in the ACL. If no ports or port rangess are provided, communication on any port on this LAN is allowed.

Ports []int64optional

Array of ports on the provided LAN that will be included in the ACL. If no ports or port ranges are provided, communication on any port on this LAN is allowed.

Subnets []Subnetoptional

Array of subnet IPs within the LAN that will be included in the ACL. If no subnets are provided, communication on any subnets on this LAN are allowed.

type AllowedProtocol string

Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.

One of the following:

const AllowedProtocolTCP AllowedProtocol = "tcp"

const AllowedProtocolUdp AllowedProtocol = "udp"

const AllowedProtocolIcmp AllowedProtocol = "icmp"

type Subnet string

A valid IPv4 address.

Magic TransitSitesLANs

List Site LANs

client.MagicTransit.Sites.LANs.List(ctx, siteID, query) (*SinglePage[LAN], error)

GET/accounts/{account_id}/magic/sites/{site_id}/lans

Site LAN Details

client.MagicTransit.Sites.LANs.Get(ctx, siteID, lanID, query) (*LAN, error)

GET/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Create a new Site LAN

client.MagicTransit.Sites.LANs.New(ctx, siteID, params) (*SinglePage[LAN], error)

POST/accounts/{account_id}/magic/sites/{site_id}/lans

Update Site LAN

client.MagicTransit.Sites.LANs.Update(ctx, siteID, lanID, params) (*LAN, error)

PUT/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Patch Site LAN

client.MagicTransit.Sites.LANs.Edit(ctx, siteID, lanID, params) (*LAN, error)

PATCH/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Delete Site LAN

client.MagicTransit.Sites.LANs.Delete(ctx, siteID, lanID, body) (*LAN, error)

DELETE/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

ModelsExpand Collapse

type DHCPRelay struct{…}

ServerAddresses []stringoptional

List of DHCP server IPs.

type DHCPServer struct{…}

DHCPPoolEnd stringoptional

A valid IPv4 address.

DHCPPoolStart stringoptional

A valid IPv4 address.

DNSServer stringoptional

A valid IPv4 address.

DNSServers []stringoptional

Reservations map[string, string]optional

Mapping of MAC addresses to IP addresses

type LAN struct{…}

ID stringoptional

Identifier

maxLength32

BondID int64optional

HaLink booloptional

mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.

IsBreakout booloptional

mark true to use this LAN for source-based breakout traffic

IsPrioritized booloptional

mark true to use this LAN for source-based prioritized traffic

Name stringoptional

Nat Natoptional

Physport int64optional

RoutedSubnets []RoutedSubnetoptional

NextHop string

A valid IPv4 address.

Prefix string

A valid CIDR notation representing an IP range.

Nat Natoptional

SiteID stringoptional

Identifier

maxLength32

StaticAddressing LANStaticAddressingoptional

If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.

VlanTag int64optional

VLAN ID. Use zero for untagged.

type LANStaticAddressing struct{…}

If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.

Address string

A valid CIDR notation representing an IP range.

DHCPRelay DHCPRelayoptional

DHCPServer DHCPServeroptional

SecondaryAddress stringoptional

A valid CIDR notation representing an IP range.

VirtualAddress stringoptional

A valid CIDR notation representing an IP range.

type Nat struct{…}

StaticPrefix stringoptional

A valid CIDR notation representing an IP range.

type RoutedSubnet struct{…}

NextHop string

A valid IPv4 address.

Prefix string

A valid CIDR notation representing an IP range.

Nat Natoptional

Magic TransitSitesWANs

List Site WANs

client.MagicTransit.Sites.WANs.List(ctx, siteID, query) (*SinglePage[WAN], error)

GET/accounts/{account_id}/magic/sites/{site_id}/wans

Site WAN Details

client.MagicTransit.Sites.WANs.Get(ctx, siteID, wanID, query) (*WAN, error)

GET/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}

Create a new Site WAN

client.MagicTransit.Sites.WANs.New(ctx, siteID, params) (*SinglePage[WAN], error)

POST/accounts/{account_id}/magic/sites/{site_id}/wans

Update Site WAN

client.MagicTransit.Sites.WANs.Update(ctx, siteID, wanID, params) (*WAN, error)

PUT/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}

Patch Site WAN

client.MagicTransit.Sites.WANs.Edit(ctx, siteID, wanID, params) (*WAN, error)

PATCH/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}

Delete Site WAN

client.MagicTransit.Sites.WANs.Delete(ctx, siteID, wanID, body) (*WAN, error)

DELETE/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}

ModelsExpand Collapse

type WAN struct{…}

ID stringoptional

Identifier

maxLength32

HealthCheckRate WANHealthCheckRateoptional

Magic WAN health check rate for tunnels created on this link. The default value is mid.

One of the following:

const WANHealthCheckRateLow WANHealthCheckRate = "low"

const WANHealthCheckRateMid WANHealthCheckRate = "mid"

const WANHealthCheckRateHigh WANHealthCheckRate = "high"

Name stringoptional

Physport int64optional

Priority int64optional

Priority of WAN for traffic loadbalancing.

SiteID stringoptional

Identifier

maxLength32

StaticAddressing WANStaticAddressingoptional

(optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.

VlanTag int64optional

VLAN ID. Use zero for untagged.

type WANStaticAddressing struct{…}

(optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.

Address string

A valid CIDR notation representing an IP range.

GatewayAddress string

A valid IPv4 address.

SecondaryAddress stringoptional

A valid CIDR notation representing an IP range.

Magic TransitConnectors

List Connectors

client.MagicTransit.Connectors.List(ctx, query) (*SinglePage[ConnectorListResponse], error)

GET/accounts/{account_id}/magic/connectors

Fetch Connector

client.MagicTransit.Connectors.Get(ctx, connectorID, query) (*ConnectorGetResponse, error)

GET/accounts/{account_id}/magic/connectors/{connector_id}

Add a connector to your account

client.MagicTransit.Connectors.New(ctx, params) (*ConnectorNewResponse, error)

POST/accounts/{account_id}/magic/connectors

Replace Connector or Re-provision License Key

client.MagicTransit.Connectors.Update(ctx, connectorID, params) (*ConnectorUpdateResponse, error)

PUT/accounts/{account_id}/magic/connectors/{connector_id}

Edit Connector to update specific properties or Re-provision License Key

client.MagicTransit.Connectors.Edit(ctx, connectorID, params) (*ConnectorEditResponse, error)

PATCH/accounts/{account_id}/magic/connectors/{connector_id}

Remove a connector from your account

client.MagicTransit.Connectors.Delete(ctx, connectorID, body) (*ConnectorDeleteResponse, error)

DELETE/accounts/{account_id}/magic/connectors/{connector_id}

Magic TransitConnectorsEvents

List Events

client.MagicTransit.Connectors.Events.List(ctx, connectorID, params) (*ConnectorEventListResponse, error)

GET/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events

Get Event

client.MagicTransit.Connectors.Events.Get(ctx, connectorID, eventT, eventN, query) (*ConnectorEventGetResponse, error)

GET/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/{event_t}.{event_n}

Magic TransitConnectorsEventsLatest

Get latest Events

client.MagicTransit.Connectors.Events.Latest.List(ctx, connectorID, query) (*ConnectorEventLatestListResponse, error)

GET/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/latest

Magic TransitConnectorsSnapshots

List Snapshots

client.MagicTransit.Connectors.Snapshots.List(ctx, connectorID, params) (*ConnectorSnapshotListResponse, error)

GET/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots

Get Snapshot

client.MagicTransit.Connectors.Snapshots.Get(ctx, connectorID, snapshotT, query) (*ConnectorSnapshotGetResponse, error)

GET/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/{snapshot_t}

Magic TransitConnectorsSnapshotsLatest

Get latest Snapshots

client.MagicTransit.Connectors.Snapshots.Latest.List(ctx, connectorID, query) (*ConnectorSnapshotLatestListResponse, error)

GET/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/latest

Magic TransitPCAPs

List packet capture requests

client.MagicTransit.PCAPs.List(ctx, query) (*SinglePage[PCAPListResponse], error)

GET/accounts/{account_id}/pcaps

Get PCAP request

client.MagicTransit.PCAPs.Get(ctx, pcapID, query) (*PCAPGetResponse, error)

GET/accounts/{account_id}/pcaps/{pcap_id}

Create PCAP request

client.MagicTransit.PCAPs.New(ctx, params) (*PCAPNewResponse, error)

POST/accounts/{account_id}/pcaps

Stop full PCAP

client.MagicTransit.PCAPs.Stop(ctx, pcapID, body) error

PUT/accounts/{account_id}/pcaps/{pcap_id}/stop

ModelsExpand Collapse

type PCAP struct{…}

ID stringoptional

The ID for the packet capture.

maxLength32

minLength32

FilterV1 PCAPFilteroptional

The packet capture filter. When this field is empty, all packets are captured.

OffsetTime Timeoptional

The RFC 3339 offset timestamp from which to query backwards for packets. Must be within the last 24h. When this field is empty, defaults to time of request.

formatdate-time

Status PCAPStatusoptional

The status of the packet capture request.

One of the following:

const PCAPStatusUnknown PCAPStatus = "unknown"

const PCAPStatusSuccess PCAPStatus = "success"

const PCAPStatusPending PCAPStatus = "pending"

const PCAPStatusRunning PCAPStatus = "running"

const PCAPStatusConversionPending PCAPStatus = "conversion_pending"

const PCAPStatusConversionRunning PCAPStatus = "conversion_running"

const PCAPStatusComplete PCAPStatus = "complete"

const PCAPStatusFailed PCAPStatus = "failed"

Submitted stringoptional

The RFC 3339 timestamp when the packet capture was created.

System PCAPSystemoptional

The system used to collect packet captures.

TimeLimit float64optional

The packet capture duration in seconds.

maximum300

minimum1

Type PCAPTypeoptional

The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets.

One of the following:

const PCAPTypeSimple PCAPType = "simple"

const PCAPTypeFull PCAPType = "full"

type PCAPFilter struct{…}

The packet capture filter. When this field is empty, all packets are captured.

DestinationAddress stringoptional

The destination IP address of the packet.

DestinationPort float64optional

The destination port of the packet.

Protocol float64optional

The protocol number of the packet.

SourceAddress stringoptional

The source IP address of the packet.

SourcePort float64optional

The source port of the packet.

Magic TransitPCAPsOwnership

List PCAPs Bucket Ownership

client.MagicTransit.PCAPs.Ownership.Get(ctx, query) (*SinglePage[Ownership], error)

GET/accounts/{account_id}/pcaps/ownership

Add buckets for full packet captures

client.MagicTransit.PCAPs.Ownership.New(ctx, params) (*Ownership, error)

POST/accounts/{account_id}/pcaps/ownership

Delete buckets for full packet captures

client.MagicTransit.PCAPs.Ownership.Delete(ctx, ownershipID, body) error

DELETE/accounts/{account_id}/pcaps/ownership/{ownership_id}

Validate buckets for full packet captures

client.MagicTransit.PCAPs.Ownership.Validate(ctx, params) (*Ownership, error)

POST/accounts/{account_id}/pcaps/ownership/validate

ModelsExpand Collapse

type Ownership struct{…}

ID string

The bucket ID associated with the packet captures API.

maxLength32

minLength32

DestinationConf string

The full URI for the bucket. This field only applies to full packet captures.

Filename string

The ownership challenge filename stored in the bucket.

Status OwnershipStatus

The status of the ownership challenge. Can be pending, success or failed.

One of the following:

const OwnershipStatusPending OwnershipStatus = "pending"

const OwnershipStatusSuccess OwnershipStatus = "success"

const OwnershipStatusFailed OwnershipStatus = "failed"

Submitted string

The RFC 3339 timestamp when the bucket was added to packet captures API.

Validated stringoptional

The RFC 3339 timestamp when the bucket was validated.

Magic TransitPCAPsDownload

Download Simple PCAP

client.MagicTransit.PCAPs.Download.Get(ctx, pcapID, query) (*Response, error)

GET/accounts/{account_id}/pcaps/{pcap_id}/download