`origins`

`GET`

Gets all requested :term:`Origins`.

Auth. Required:	Yes
Roles Required:	None
Permissions Required:	ORIGIN:READ, DELIVERY-SERVICE:READ
Response Type:	Array

Request Structure

Request Query Parameters

Name	Required	Description
cachegroup	no	Return only :term:`Origins` within the :term:`Cache Group` that has this :ref:`cache-group-id`
coordinate	no	Return only :term:`Origins` located at the geographic coordinates identified by this integral, unique identifier
deliveryservice	no	Return only :term:`Origins` that belong to the :term:`Delivery Service` identified by this integral, unique identifier
id	no	Return only the :term:`Origin` that has this integral, unique identifier
name	no	Return only :term:`Origins` by this name
profileId	no	Return only :term:`Origins` which use the :term:`Profile` that has this :ref:`profile-id`
primary	no	If `true`, return only :term:`Origins` which are the the primary :term:`Origin` of the :term:`Delivery Service` to which they belong - if `false` return only :term:`Origins` which are not the primary :term:`Origin` of the :term:`Delivery Service` to which they belong
tenant	no	Return only :term:`Origins` belonging to the tenant identified by this integral, unique identifier
orderby	no	Choose the ordering of the results - must be the name of one of the fields of the objects in the `response` array
sortOrder	no	Changes the order of sorting. Either ascending (default or "asc") or descending ("desc")
limit	no	Choose the maximum number of results to return
offset	no	The number of results to skip before beginning to return results. Must use in conjunction with limit
page	no	Return the n^th page of results, where "n" is the value of this parameter, pages are `limit` long and the first page is 1. If `offset` was defined, this query parameter has no effect. `limit` must be defined to make use of `page`.

Note

Several fields of origin definitions which are filterable by Query Parameters are allowed to be null. null values in these fields will be filtered out appropriately by such Query Parameters, but do note that null is not a valid value accepted by any of these Query Parameters, and attempting to pass it will result in an error.

GET /api/5.0/origins?name=demo1 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

cachegroup:	A string that is the :ref:`name of the Cache Group <cache-group-name>` to which the :term:`Origin` belongs
cachegroupId:	An integer that is the :ref:`ID of the Cache Group <cache-group-id>` to which the :term:`Origin` belongs
coordinate:	The name of a coordinate pair that defines the origin's geographic location
coordinateId:	An integral, unique identifier for the coordinate pair that defines the :term:`Origin`'s geographic location
deliveryService:	A string that is the :ref:`ds-xmlid` of the :term:`Delivery Service` to which the :term:`Origin` belongs
deliveryServiceId:	An integral, unique identifier for the :term:`Delivery Service` to which the :term:`Origin` belongs
fqdn:	The :abbr:`FQDN (Fully Qualified Domain Name)` of the :term:`Origin`
id:	An integral, unique identifier for this :term:`Origin`
ip6Address:	The IPv6 address of the :term:`Origin`
ipAddress:	The IPv4 address of the :term:`Origin`
isPrimary:	A boolean value which, when `true` specifies this :term:`Origin` as the 'primary' :term:`Origin` served by `deliveryService`
lastUpdated:	The date and time at which this :term:`Origin` was last modified in RFC 3339 format .. versionchanged:: 5.0 Prior to version 5.0 of the API, this field was in :ref:`non-rfc-datetime`.
name:	The name of the :term:`Origin`
port:	The TCP port on which the :term:`Origin` listens
profile:	The :ref:`profile-name` of the :term:`Profile` used by this :term:`Origin`
profileId:	The :ref:`profile-id` of the :term:`Profile` used by this :term:`Origin`
protocol:	The protocol used by this origin - will be one of 'http' or 'https'
tenant:	The name of the :term:`Tenant` that owns this :term:`Origin`
tenantId:	An integral, unique identifier for the :term:`Tenant` that owns this :term:`Origin`

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: sm8DpvdvrfdSVLtmXTdfjsZbTlbc+pI40Gy0aj00XIURTPfFXuv/4LgHb6A3r92iymbRHvFrH6qdB2g97U2sBg==
X-Server-Name: traffic_ops_golang/
Date: Tue, 11 Dec 2018 15:43:41 GMT
Content-Length: 376

{ "response": [
        {
                "cachegroup": null,
                "cachegroupId": null,
                "coordinate": null,
                "coordinateId": null,
                "deliveryService": "demo1",
                "deliveryServiceId": 1,
                "fqdn": "origin.infra.ciab.test",
                "id": 1,
                "ip6Address": null,
                "ipAddress": null,
                "isPrimary": true,
                "lastUpdated": "2018-12-10T15:59:33.7096-06:00",
                "name": "demo1",
                "port": null,
                "profile": null,
                "profileId": null,
                "protocol": "http",
                "tenant": "root",
                "tenantId": 1
        }
]}

`POST`

Creates a new origin definition.

Warning

At the time of this writing it is possible to create and/or modify origin definitions assigned to STEERING and CLIENT_STEERING :term:`Delivery Services` - despite that an origin has no meaning in those contexts. In these cases, the API responses may give incorrect output - see GitHub Issue #3107 for details and updates.

Auth. Required:	Yes
Roles Required:	"admin" or "operations"
Permissions Required:	ORIGIN:CREATE, ORIGIN:READ, DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE
Response Type:	Object

Request Structure

cachegroupId:	An optional, integer which, if present, should be the :ref:`Cache Group ID <cache-group-id>` that identifies a :term:`Cache Group` to which the new :term:`Origin` shall belong
coordinateId:	An optional, integral, unique identifier of a coordinate pair that shall define the :term:`Origin`'s geographic location
deliveryServiceId:	The integral, unique identifier of the :term:`Delivery Service` to which the new :term:`Origin` shall belong
fqdn:	The :abbr:`FQDN (Fully Qualified Domain Name)` of the :term:`Origin`
ip6Address:	An optional string containing the IPv6 address of the :term:`Origin`
ipAddress:	An optional string containing the IPv4 address of the :term:`Origin`
isPrimary:	An optional boolean which, if `true` will set this :term:`Origin` as the 'primary' :term:`Origin` served by the :term:`Delivery Service` identified by `deliveryServiceID` Note Though not specifying this field in this request will leave it as `null` in the output, Traffic Ops will silently coerce that to its default value: `false`.
name:	A human-friendly name of the :term:`Origin`
port:	An optional port number on which the :term:`Origin` listens for incoming TCP connections
profileId:	An optional :ref:`profile-id` ofa :term:`Profile` that shall be used by this :term:`Origin`
protocol:	The protocol used by the origin - must be one of 'http' or 'https'
tenantId:	An optional[1], integral, unique identifier for the :term:`Tenant` which shall own the new :term:`Origin`

POST /api/5.0/origins HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 114
Content-Type: application/json

{
        "deliveryServiceId": 2,
        "fqdn": "example.com",
        "name": "example",
        "port": 80,
        "protocol": "http",
        "tenantId": 1
}

[1]	(1, 2) The `tenantId` field is required if and only if tenancy is enabled within Traffic Ops.

Response Structure

cachegroup:	A string that is the :ref:`name of the Cache Group <cache-group-name>` to which the :term:`Origin` belongs
cachegroupId:	An integer that is the :ref:`ID of the Cache Group <cache-group-id>` to which the :term:`Origin` belongs
coordinate:	The name of a coordinate pair that defines the origin's geographic location
coordinateId:	An integral, unique identifier for the coordinate pair that defines the :term:`Origin`'s geographic location
deliveryService:	The 'xml_id' of the :term:`Delivery Service` to which the :term:`Origin` belongs
deliveryServiceId:	An integral, unique identifier for the :term:`Delivery Service` to which the :term:`Origin` belongs
fqdn:	The :abbr:`FQDN (Fully Qualified Domain Name)` of the :term:`Origin`
id:	An integral, unique identifier for this :term:`Origin`
ip6Address:	The IPv6 address of the :term:`Origin`
ipAddress:	The IPv4 address of the :term:`Origin`
isPrimary:	A boolean value which, when `true` specifies this :term:`Origin` as the 'primary' :term:`Origin` served by `deliveryService`
lastUpdated:	The date and time at which this :term:`Origin` was last modified in RFC 3339 format .. versionchanged:: 5.0 Prior to version 5.0 of the API, this field was in :ref:`non-rfc-datetime`.
name:	The name of the :term:`Origin`
port:	The TCP port on which the :term:`Origin` listens
profile:	The :ref:`profile-name` of the :term:`Profile` used by this :term:`Origin`
profileId:	The :ref:`profile-id` the :term:`Profile` used by this :term:`Origin`
protocol:	The protocol used by this origin - will be one of 'http' or 'https'
tenant:	The name of the :term:`Tenant` that owns this :term:`Origin`
tenantId:	An integral, unique identifier for the :term:`Tenant` that owns this :term:`Origin`

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: z4gp0MaqYu+gSRORhKT2eObVBuVDVx1rdteRaN5kRL9uJ3hNzUCi4dSKIt0rgNgOEDt6x/iTYrmVhr/TSHYtmA==
X-Server-Name: traffic_ops_golang/
Date: Tue, 11 Dec 2018 15:14:27 GMT
Content-Length: 418

{ "alerts": [
        {
                "text": "origin was created.",
                "level": "success"
        }
],
"response": {
        "cachegroup": null,
        "cachegroupId": null,
        "coordinate": null,
        "coordinateId": null,
        "deliveryService": null,
        "deliveryServiceId": 2,
        "fqdn": "example.com",
        "id": 2,
        "ip6Address": null,
        "ipAddress": null,
        "isPrimary": null,
        "lastUpdated": "2018-12-11T15:59:33.7096-06:00",
        "name": "example",
        "port": 80,
        "profile": null,
        "profileId": null,
        "protocol": "http",
        "tenant": null,
        "tenantId": 1
}}

`PUT`

Updates an :term:`Origin` definition.

Auth. Required:	Yes
Roles Required:	"admin" or "operations"
Permissions Required:	ORIGIN:UPDATE, ORIGIN:READ, DELIVERY-SERVICE:READ, DELIVERY-SERVICE:UPDATE
Response Type:	Object

Request Structure

Request Query Parameters

Name	Required	Description
id	yes	The integral, unique identifier of the :term:`Origin` definition being edited

cachegroupId:	An optional, integer which, if present, should be the :ref:`Cache Group ID <cache-group-id>` that identifies a :term:`Cache Group` to which the new :term:`Origin` shall belong
coordinateId:	An optional, integral, unique identifier of a coordinate pair that shall define the :term:`Origin`'s geographic location
deliveryServiceId:	The integral, unique identifier of the :term:`Delivery Service` to which the :term:`Origin` shall belong
fqdn:	The :abbr:`FQDN (Fully Qualified Domain Name)` of the :term:`Origin`
ip6Address:	An optional string containing the IPv6 address of the :term:`Origin`
ipAddress:	An optional string containing the IPv4 address of the :term:`Origin`
isPrimary:	An optional boolean which, if `true` will set this :term:`Origin` as the 'primary' origin served by the :term:`Delivery Service` identified by `deliveryServiceID`
name:	A human-friendly name of the :term:`Origin`
port:	An optional port number on which the :term:`Origin` listens for incoming TCP connections
profileId:	An optional :ref:`profile-id` of the :term:`Profile` that shall be used by this :term:`Origin`
protocol:	The protocol used by the :term:`Origin` - must be one of 'http' or 'https'
tenantId:	An optional[1], integral, unique identifier for the :term:`Tenant` which shall own the new :term:`Origin`

PUT /api/5.0/origins?id=2 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 135
Content-Type: application/json

{
        "deliveryServiceId": 2,
        "fqdn": "example.com",
        "isprimary": true,
        "name": "example",
        "port": 443,
        "protocol": "https",
        "tenantId": 1
}

Response Structure

cachegroup:	A string that is the :ref:`name of the Cache Group <cache-group-name>` to which the :term:`Origin` belongs
cachegroupId:	An integer that is the :ref:`ID of the Cache Group <cache-group-id>` to which the :term:`Origin` belongs
coordinate:	The name of a coordinate pair that defines the origin's geographic location
coordinateId:	An integral, unique identifier for the coordinate pair that defines the :term:`Origin`'s geographic location
deliveryService:	The 'xml_id' of the :term:`Delivery Service` to which the :term:`Origin` belongs
deliveryServiceId:	An integral, unique identifier for the :term:`Delivery Service` to which the :term:`Origin` belongs
fqdn:	The :abbr:`FQDN (Fully Qualified Domain Name)` of the :term:`Origin`
id:	An integral, unique identifier for this :term:`Origin`
ip6Address:	The IPv6 address of the :term:`Origin`
ipAddress:	The IPv4 address of the :term:`Origin`
isPrimary:	A boolean value which, when `true` specifies this :term:`Origin` as the 'primary' :term:`Origin` served by `deliveryService`
lastUpdated:	The date and time at which this :term:`Origin` was last modified in RFC 3339 format .. versionchanged:: 5.0 Prior to version 5.0 of the API, this field was in :ref:`non-rfc-datetime`.
name:	The name of the :term:`Origin`
port:	The TCP port on which the :term:`Origin` listens
profile:	The :ref:`profile-name` of the :term:`Profile` used by this :term:`Origin`
profileId:	The :ref:`profile-id` the :term:`Profile` used by this :term:`Origin`
protocol:	The protocol used by this origin - will be one of 'http' or 'https'
tenant:	The name of the :term:`Tenant` that owns this :term:`Origin`
tenantId:	An integral, unique identifier for the :term:`Tenant` that owns this :term:`Origin`

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: Zx7jOa7UAQxRtDenYodvGQSoooPj4m0yY0AIeUpbdelmYMiNdPYtW82BCmMesFXkmP74nV4HbTUyDHVMuJxZ7g==
X-Server-Name: traffic_ops_golang/
Date: Tue, 11 Dec 2018 15:40:53 GMT
Content-Length: 420

{ "alerts": [
        {
                "text": "origin was updated.",
                "level": "success"
        }
],
"response": {
        "cachegroup": null,
        "cachegroupId": null,
        "coordinate": null,
        "coordinateId": null,
        "deliveryService": null,
        "deliveryServiceId": 2,
        "fqdn": "example.com",
        "id": 2,
        "ip6Address": null,
        "ipAddress": null,
        "isPrimary": true,
        "lastUpdated": "2018-12-11T17:59:33.7096-06:00",
        "name": "example",
        "port": 443,
        "profile": null,
        "profileId": null,
        "protocol": "https",
        "tenant": null,
        "tenantId": 1
}}

`DELETE`

Deletes an :term:`Origin` definition.

Auth. Required:	Yes
Roles Required:	"admin" or "operations"
Permissions Required:	ORIGIN:DELETE, DELIVERY-SERVICE:UPDATE
Response Type:	`undefined`

Request Structure

Request Query Parameters

Name	Required	Description
id	yes	The integral, unique identifier of the :term:`Origin` definition being deleted

DELETE /api/5.0/origins?id=2 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: fLaY4/nh0yR38xq5weBKYg02+aQV6Z1ZroOq9UqUCHLMMrH1NMyhOHx+EphPq7JxkjmGY04WCt6VvDyjGWcgfQ==
X-Server-Name: traffic_ops_golang/
Date: Tue, 11 Dec 2018 17:04:14 GMT
Content-Length: 61

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

origins.rst

origins.rst

`origins`

`GET`

Request Structure

Response Structure

`POST`

Request Structure

Response Structure

`PUT`

Request Structure

Response Structure

`DELETE`

Request Structure

Response Structure

Files

origins.rst

Latest commit

History

origins.rst

File metadata and controls

origins

GET

Request Structure

Response Structure

POST

Request Structure

Response Structure

PUT

Request Structure

Response Structure

DELETE

Request Structure

Response Structure

`origins`

`GET`

`POST`

`PUT`

`DELETE`