Origin

/api/1.3/origins

GET /api/1.3/origins

Get Origins.

Authentication Required: Yes

Role(s) Required: None

Request Query Parameters

Name	Required	Description
cachegroup	no	Filter Origins by cachegroup ID.
coordinate	no	Filter Origins by coordinate ID.
deliveryservice	no	Filter Origins by deliveryservice ID.
id	no	Filter Origins by ID.
name	no	Filter Origins by name.
profileId	no	Filter Origins by profile ID.
primary	no	Filter Origins by isPrimary.
tenant	no	Filter Origins by tenant ID.

Response Properties

Parameter	Type	Description
cachegroup	string	Name of the Origin’s cachegroup
cachegroupId	int	ID of the Origin’s cachegroup
coordinate	string	Name of the Origin’s coordinate
coordinateID	int	ID of the Origin’s coordinate
deliveryService	string	XML_ID of the Origin’s delivery service
deliveryServiceId	int	ID of the Origin’s delivery service
fqdn	string	The FQDN of the Origin
id	int	Local unique identifier for the Origin
ip6Address	string	IPv6 address of the Origin
ipAddress	string	IPv4 address of the Origin
isPrimary	boolean	Whether or not this is the primary Origin for the delivery service
lastUpdated	string	The Time / Date this entry was last updated
name	string	The name of the Origin
port	int	The TCP port on which the Origin listens
profile	string	The profile name of the Origin
profileId	int	The profile ID of the Origin
protocol	string	The protocol of the Origin’s URL (http or https)
tenant	string	The tenant name of the Origin
tenantId	int	The tenant ID of the Origin

Response Example

{
    "response": [
        {
            "cachegroup": "cg1",
            "cachegroupId": 1,
            "coordinate": "coordinate1",
            "coordinateId": 1,
            "deliveryService": "myds",
            "deliveryServiceId": 1,
            "fqdn": "example.com",
            "id": 1,
            "ip6Address": "cafe:dead:d0d0::42",
            "ipAddress": "10.2.3.4",
            "isPrimary": false,
            "lastUpdated": "2018-05-08 19:33:18+00",
            "name": "my-origin",
            "port": 443,
            "profile": "my-origins",
            "profileId": 1,
            "protocol": "https",
            "tenant": "tenantA",
            "tenantId": 3
        },
        {
            "cachegroup": null,
            "cachegroupId": null,
            "coordinate": null,
            "coordinateId": null,
            "deliveryService": null,
            "deliveryServiceId": null,
            "fqdn": "foo.example.com",
            "id": 2,
            "ip6Address": null,
            "ipAddress": null,
            "isPrimary": false,
            "lastUpdated": "2018-05-08 19:35:12+00",
            "name": "origin2",
            "port": null,
            "profile": null,
            "profileId": null,
            "protocol": "http",
            "tenant": null,
            "tenantId": null
        }
    ]
}

POST /api/1.3/origins

Create Origin.

Authentication Required: Yes

Role(s) Required: admin or oper

Request Parameters

Name	Required	Description
cachegroupId	no	ID of the Origin’s cachegroup
coordinateID	no	ID of the Origin’s coordinate
deliveryServiceId	yes	ID of the Origin’s delivery service
fqdn	yes	The FQDN of the Origin
ip6Address	no	IPv6 address of the Origin
ipAddress	no	IPv4 address of the Origin
name	yes	The name of the Origin
port	no	The TCP port on which the Origin listens
profileId	no	The profile ID of the Origin
protocol	yes	The protocol of the Origin’s URL (http or https)
tenantId	no	The tenant ID of the Origin

Request Example

{
    "cachegroupId": 1,
    "coordinateId": 1,
    "deliveryServiceId": 1,
    "fqdn": "foo.example.com",
    "ip6Address": "cafe:dead:d0d0::42",
    "ipAddress": "10.2.3.4",
    "name": "origin1",
    "port": 443,
    "profileId": 1,
    "protocol": "https",
    "tenantId": 1
}

Response Properties

Parameter	Type	Description
cachegroup	string	Name of the Origin’s cachegroup
cachegroupId	int	ID of the Origin’s cachegroup
coordinate	string	Name of the Origin’s coordinate
coordinateID	int	ID of the Origin’s coordinate
deliveryService	string	XML_ID of the Origin’s delivery service
deliveryServiceId	int	ID of the Origin’s delivery service
fqdn	string	The FQDN of the Origin
id	int	Local unique identifier for the Origin
ip6Address	string	IPv6 address of the Origin
ipAddress	string	IPv4 address of the Origin
isPrimary	boolean	Whether or not this is the primary Origin for the delivery service
lastUpdated	string	The Time / Date this entry was last updated
name	string	The name of the Origin
port	int	The TCP port on which the Origin listens
profile	string	The profile name of the Origin
profileId	int	The profile ID of the Origin
protocol	string	The protocol of the Origin’s URL (http or https)
tenant	string	The tenant name of the Origin
tenantId	int	The tenant ID of the Origin
alerts	array	A collection of alert messages.
>level	string	Success, info, warning or error.
>text	string	Alert message.

Response Example

{
    "alerts": [
        {
            "level": "success",
            "text": "origin was created."
        }
    ],
    "response": {
        "cachegroup": null,
        "cachegroupId": 1,
        "coordinate": null,
        "coordinateId": 1,
        "deliveryService": null,
        "deliveryServiceId": 1,
        "fqdn": "foo.example.com",
        "id": 1,
        "ip6Address": "cafe:dead:d0d0::42",
        "ipAddress": "10.2.3.4",
        "isPrimary": false,
        "lastUpdated": "2018-05-08 20:30:27+00",
        "name": "origin1",
        "port": 443,
        "profile": null,
        "profileId": 1,
        "protocol": "https",
        "tenant": null,
        "tenantId": 1
    }
}

PUT /api/1.3/origins

Update origin.

Authentication Required: Yes

Role(s) Required: admin or oper

Request Query Parameters

Name	Required	Description
id	yes	The id of the coordinate to edit.

Request Parameters

Name	Required	Description
cachegroupId	no	ID of the Origin’s cachegroup
coordinateID	no	ID of the Origin’s coordinate
deliveryServiceId	yes	ID of the Origin’s delivery service
fqdn	yes	The FQDN of the Origin
id	yes	The ID of the Origin
ip6Address	no	IPv6 address of the Origin
ipAddress	no	IPv4 address of the Origin
name	yes	The name of the Origin
port	no	The TCP port on which the Origin listens
profileId	no	The profile ID of the Origin
protocol	yes	The protocol of the Origin’s URL (http or https)
tenantId	no	The tenant ID of the Origin

Request Example

{
    "cachegroupId": 1,
    "coordinateId": 1,
    "deliveryServiceId": 1,
    "fqdn": "foo.example.com",
    "id": 1,
    "ip6Address": "cafe:dead:d0d0::42",
    "ipAddress": "10.2.3.4",
    "name": "origin1",
    "port": 443,
    "profileId": 1,
    "protocol": "https",
    "tenantId": 1
}

Response Properties

Parameter	Type	Description
cachegroup	string	Name of the Origin’s cachegroup
cachegroupId	int	ID of the Origin’s cachegroup
coordinate	string	Name of the Origin’s coordinate
coordinateID	int	ID of the Origin’s coordinate
deliveryService	string	XML_ID of the Origin’s delivery service
deliveryServiceId	int	ID of the Origin’s delivery service
fqdn	string	The FQDN of the Origin
id	int	Local unique identifier for the Origin
ip6Address	string	IPv6 address of the Origin
ipAddress	string	IPv4 address of the Origin
isPrimary	boolean	Whether or not this is the primary Origin for the delivery service
lastUpdated	string	The Time / Date this entry was last updated
name	string	The name of the Origin
port	int	The TCP port on which the Origin listens
profile	string	The profile name of the Origin
profileId	int	The profile ID of the Origin
protocol	string	The protocol of the Origin’s URL (http or https)
tenant	string	The tenant name of the Origin
tenantId	int	The tenant ID of the Origin
alerts	array	A collection of alert messages.
>level	string	Success, info, warning or error.
>text	string	Alert message.

Response Example

{
    "alerts": [
        {
            "level": "success",
            "text": "origin was updated."
        }
    ],
    "response": {
        "cachegroup": null,
        "cachegroupId": 1,
        "coordinate": null,
        "coordinateId": 1,
        "deliveryService": null,
        "deliveryServiceId": 1,
        "fqdn": "foo.example.com",
        "id": 1,
        "ip6Address": "cafe:dead:d0d0::42",
        "ipAddress": "10.2.3.4",
        "isPrimary": false,
        "lastUpdated": "2018-05-08 20:30:27+00",
        "name": "origin1",
        "port": 443,
        "profile": null,
        "profileId": 1,
        "protocol": "https",
        "tenant": null,
        "tenantId": 1
    }
}

DELETE /api/1.3/origin

Delete origin.

Authentication Required: Yes

Role(s) Required: admin or oper

Request Query Parameters

Name	Required	Description
id	yes	The id of the origin to delete.

Response Properties

Parameter	Type	Description
alerts	array	A collection of alert messages.
>level	string	Success, info, warning or error.
>text	string	Alert message.

Response Example

{
      "alerts": [
                {
                        "level": "success",
                        "text": "origin was deleted"
                }
        ]
}