API Reference

Magic Transit

Cf1 Sites

Ramps

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create CF1 Site Ramps

client.MagicTransit.Cf1Sites.Ramps.New(ctx, cf1SiteID, params) (*SinglePage[Ramp], error)

POST/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps

Creates ramps (network connections) for a CF1 Site.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

cf1SiteID string

Identifier

maxLength32

params Cf1SiteRampNewParams

AccountID param.Field[string]

Path param: Identifier

maxLength32

Body param.Field[[]Cf1SiteRampNewParamsBody]

Body param

SourceRampID string

Identifier of the source network resource to associate as a ramp.

maxLength32

Type RampType

The type of network connection (ramp) linking a CF1 Site to Cloudflare’s network.

One of the following:

const RampTypeGRE RampType = "gre"

const RampTypeGREInterconnect RampType = "gre_interconnect"

const RampTypeMplsInterconnect RampType = "mpls_interconnect"

const RampTypeMconn RampType = "mconn"

const RampTypeIPSEC RampType = "ipsec"

ReturnsExpand Collapse

type Ramp struct{…}

ID string

Identifier

maxLength32

CreatedOn Time

formatdate-time

ModifiedOn Time

formatdate-time

Name string

A human-provided name describing the ramp that should be unique within the CF1 Site.

Type RampType

The type of network connection (ramp) linking a CF1 Site to Cloudflare’s network.

One of the following:

const RampTypeGRE RampType = "gre"

const RampTypeGREInterconnect RampType = "gre_interconnect"

const RampTypeMplsInterconnect RampType = "mpls_interconnect"

const RampTypeMconn RampType = "mconn"

const RampTypeIPSEC RampType = "ipsec"

Description stringOptional

A human-provided description of the ramp.

GRE RampGREOptional

ManagedBy stringOptional

URL reference to the source network resource that this ramp is managed by.

GREInterconnect RampGREInterconnectOptional

ManagedBy stringOptional

URL reference to the source network resource that this ramp is managed by.

IPSEC RampIPSECOptional

ManagedBy stringOptional

URL reference to the source network resource that this ramp is managed by.

Mconn RampMconnOptional

ManagedBy stringOptional

URL reference to the source network resource that this ramp is managed by.

MplsInterconnect RampMplsInterconnectOptional

ManagedBy stringOptional

URL reference to the source network resource that this ramp is managed by.

Create CF1 Site Ramps

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/magic_transit"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.MagicTransit.Cf1Sites.Ramps.New(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    magic_transit.Cf1SiteRampNewParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      Body: []magic_transit.Cf1SiteRampNewParamsBody{magic_transit.Cf1SiteRampNewParamsBody{
        SourceRampID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
        Type: cloudflare.F(magic_transit.RampTypeGRE),
      }},
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "created_on": "2019-12-27T18:11:19.117Z",
      "modified_on": "2019-12-27T18:11:19.117Z",
      "name": "primary_gre_ramp",
      "type": "gre",
      "description": "Primary CF GRE tunnel",
      "gre": {
        "managed_by": "managed_by"
      },
      "gre_interconnect": {
        "managed_by": "managed_by"
      },
      "ipsec": {
        "managed_by": "managed_by"
      },
      "mconn": {
        "managed_by": "managed_by"
      },
      "mpls_interconnect": {
        "managed_by": "managed_by"
      }
    }
  ],
  "success": true
}

Returns Examples

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "created_on": "2019-12-27T18:11:19.117Z",
      "modified_on": "2019-12-27T18:11:19.117Z",
      "name": "primary_gre_ramp",
      "type": "gre",
      "description": "Primary CF GRE tunnel",
      "gre": {
        "managed_by": "managed_by"
      },
      "gre_interconnect": {
        "managed_by": "managed_by"
      },
      "ipsec": {
        "managed_by": "managed_by"
      },
      "mconn": {
        "managed_by": "managed_by"
      },
      "mpls_interconnect": {
        "managed_by": "managed_by"
      }
    }
  ],
  "success": true
}