Skip to content

Create CF1 Site Ramps

client.magicTransit.cf1Sites.ramps.create(, , ?): SinglePage<Ramp { id, created_on, modified_on, 8 more } >

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: RampCreateParams { account_id, body }

account_id: string

Path param: Identifier

maxLength32

body: Array<Body>

Body param

source_ramp_id: string

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

maxLength32

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

One of the following:

"gre"

"gre_interconnect"

"mpls_interconnect"

"mconn"

"ipsec"

ReturnsExpand Collapse

Ramp { id, created_on, modified_on, 8 more }

id: string

Identifier

maxLength32

created_on: string

formatdate-time

modified_on: string

formatdate-time

name: string

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

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

One of the following:

"gre"

"gre_interconnect"

"mpls_interconnect"

"mconn"

"ipsec"

description?: string

A human-provided description of the ramp.

gre?: GRE { managed_by }

managed_by?: string

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

gre_interconnect?: GREInterconnect { managed_by }

managed_by?: string

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

ipsec?: IPSEC { managed_by }

managed_by?: string

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

mconn?: Mconn { managed_by }

managed_by?: string

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

mpls_interconnect?: MplsInterconnect { managed_by }

managed_by?: string

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

Create CF1 Site Ramps

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const ramp of client.magicTransit.cf1Sites.ramps.create(
  '023e105f4ecef8ad9ca31a8372d0c353',
  {
    account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    body: [{ source_ramp_id: '023e105f4ecef8ad9ca31a8372d0c353', type: 'gre' }],
  },
)) {
  console.log(ramp.id);
}

{
  "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

{
  "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
}