Skip to content

Commit 9ce4886

Browse files
author
Matthew Fisher
committed
docs(reference): add ps:restart API docs
1 parent 73f6dea commit 9ce4886

1 file changed

Lines changed: 106 additions & 0 deletions

File tree

docs/reference/api-v1.3.rst

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ What's New
1515
**New!** ``/users`` endpoint for listing users
1616
**New!** ``/logs`` endpoint now has a option for limiting the number of log lines returned
1717
**New!** ``/certs`` endpoint now has an optional parameter to set the common name for a certificate
18+
**New!** ``deis ps:restart`` endpoints for restarting processes by app, process type, or process ID
1819

1920

2021
Authentication
@@ -518,6 +519,111 @@ Example Response:
518519
}
519520
520521
522+
Restart All Containers
523+
``````````````````````
524+
525+
Example Request:
526+
527+
.. code-block:: console
528+
529+
POST /v1/apps/example-go/containers/restart/ HTTP/1.1
530+
Host: deis.example.com
531+
Authorization: token abc123
532+
533+
Example Response:
534+
535+
.. code-block:: console
536+
537+
HTTP/1.1 200 OK
538+
X_DEIS_API_VERSION: 1.3
539+
X_DEIS_PLATFORM_VERSION: 1.6.0
540+
Content-Type: application/json
541+
542+
[
543+
{
544+
"owner": "test",
545+
"app": "example-go",
546+
"release": "v2",
547+
"created": "2014-01-01T00:00:00UTC",
548+
"updated": "2014-01-01T00:00:00UTC",
549+
"uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
550+
"type": "web",
551+
"num": 1,
552+
"state": "up"
553+
}
554+
]
555+
556+
557+
Restart Containers by Type
558+
``````````````````````````
559+
560+
Example Request:
561+
562+
.. code-block:: console
563+
564+
POST /v1/apps/example-go/containers/web/restart/ HTTP/1.1
565+
Host: deis.example.com
566+
Authorization: token abc123
567+
568+
Example Response:
569+
570+
.. code-block:: console
571+
572+
HTTP/1.1 200 OK
573+
X_DEIS_API_VERSION: 1.3
574+
X_DEIS_PLATFORM_VERSION: 1.6.0
575+
Content-Type: application/json
576+
577+
[
578+
{
579+
"owner": "test",
580+
"app": "example-go",
581+
"release": "v2",
582+
"created": "2014-01-01T00:00:00UTC",
583+
"updated": "2014-01-01T00:00:00UTC",
584+
"uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
585+
"type": "web",
586+
"num": 1,
587+
"state": "up"
588+
}
589+
]
590+
591+
592+
Restart Containers by Type and Number
593+
`````````````````````````````````````
594+
595+
Example Request:
596+
597+
.. code-block:: console
598+
599+
POST /v1/apps/example-go/containers/web/1/restart/ HTTP/1.1
600+
Host: deis.example.com
601+
Authorization: token abc123
602+
603+
Example Response:
604+
605+
.. code-block:: console
606+
607+
HTTP/1.1 200 OK
608+
X_DEIS_API_VERSION: 1.3
609+
X_DEIS_PLATFORM_VERSION: 1.6.0
610+
Content-Type: application/json
611+
612+
[
613+
{
614+
"owner": "test",
615+
"app": "example-go",
616+
"release": "v2",
617+
"created": "2014-01-01T00:00:00UTC",
618+
"updated": "2014-01-01T00:00:00UTC",
619+
"uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
620+
"type": "web",
621+
"num": 1,
622+
"state": "up"
623+
}
624+
]
625+
626+
521627
Scale Containers
522628
````````````````
523629

0 commit comments

Comments
 (0)