88 checks, plugins, initialisation hooks, service introspection, and more.
99 termsOfService : https://www.localstack.cloud/legal/tos
1010 title : LocalStack REST API
11- version : 4.12 .0
11+ version : 4.13 .0
1212externalDocs :
1313 description : LocalStack Documentation
1414 url : https://docs.localstack.cloud
@@ -1231,6 +1231,8 @@ paths:
12311231 schema :
12321232 type : object
12331233 description : Current LocalStack configuration
1234+ ' 404 ' :
1235+ description : Not found
12341236 post :
12351237 description : Configuration option to update with new value
12361238 operationId : update_config_option
@@ -1276,6 +1278,8 @@ paths:
12761278 content :
12771279 application/json : {}
12781280 description : Bad request
1281+ ' 404 ' :
1282+ description : Not found
12791283 /_localstack/diagnose :
12801284 get :
12811285 description : Get diagnostics report
@@ -1291,6 +1295,8 @@ paths:
12911295 properties :
12921296 config :
12931297 type : object
1298+ docker-dependent-image-hashes :
1299+ type : object
12941300 docker-dependent-image-hosts :
12951301 type : object
12961302 docker-inspect :
@@ -1526,6 +1532,12 @@ paths:
15261532 schema :
15271533 $ref : ' #/components/schemas/InitScriptsStage'
15281534 description : Information about init scripts in a specific stage
1535+ ' 404 ' :
1536+ content :
1537+ text/plain :
1538+ schema :
1539+ type : string
1540+ description : Stage not found
15291541 /_localstack/plugins :
15301542 get :
15311543 description : ' '
@@ -1827,6 +1839,8 @@ paths:
18271839 application/json :
18281840 schema :
18291841 $ref : ' #/components/schemas/NetworkEffectsConfig'
1842+ 400 :
1843+ description : Invalid request
18301844 get :
18311845 summary : Get current network effects configuration
18321846 tags :
@@ -1889,6 +1903,8 @@ paths:
18891903 uniqueItems : true
18901904 items :
18911905 $ref : ' #/components/schemas/FaultRule'
1906+ 400 :
1907+ description : Invalid request
18921908 patch :
18931909 summary : Add a new set of rules to the current configuration
18941910 description : Add new rules to the existing fault configuration.
@@ -1945,6 +1961,8 @@ paths:
19451961 uniqueItems : true
19461962 items :
19471963 $ref : ' #/components/schemas/FaultRule'
1964+ 400 :
1965+ description : Invalid request
19481966 /_localstack/cloudformation/deploy :
19491967 get :
19501968 description : UI to deploy and manage your CloudFormation stacks using public
@@ -1958,6 +1976,8 @@ paths:
19581976 type : string
19591977 format : uri
19601978 responses :
1979+ ' 404 ' :
1980+ description : Template not found.
19611981 ' 200 ' :
19621982 description : HTML page for CloudFormation deployment.
19631983 content :
@@ -1990,6 +2010,37 @@ paths:
19902010 schema :
19912011 $ref : ' #/components/schemas/PodList'
19922012 description : The list of Cloud Pods associated with a given identity
2013+ post :
2014+ description : Loads a pod state from a zip file and restores its services.
2015+ tags :
2016+ - pro
2017+ - pods
2018+ requestBody :
2019+ required : true
2020+ content :
2021+ multipart/form-data :
2022+ schema :
2023+ type : object
2024+ properties :
2025+ pod :
2026+ type : string
2027+ format : binary
2028+ required :
2029+ - pod
2030+ application/octet-stream :
2031+ schema :
2032+ type : string
2033+ format : binary
2034+ responses :
2035+ ' 201 ' :
2036+ description : Pod state loaded successfully.
2037+ headers :
2038+ Content-Length :
2039+ description : Length of the pod in bytes.
2040+ schema :
2041+ type : integer
2042+ ' 400 ' :
2043+ description : Bad request.
19932044 /_localstack/pods/environment :
19942045 get :
19952046 description : |
@@ -2058,6 +2109,8 @@ paths:
20582109 application/json :
20592110 schema :
20602111 $ref : ' #/components/schemas/PodRemote'
2112+ ' 404 ' :
2113+ description : Remote not found
20612114 post :
20622115 summary : Create a new remote
20632116 description : Creates a new remote with the specified name and configuration.
@@ -2154,37 +2207,6 @@ paths:
21542207 description : The size of the pod file in bytes.
21552208 schema :
21562209 type : integer
2157- post :
2158- description : Loads a pod state from a zip file and restores its services.
2159- tags :
2160- - pro
2161- - pods
2162- requestBody :
2163- required : true
2164- content :
2165- multipart/form-data :
2166- schema :
2167- type : object
2168- properties :
2169- pod :
2170- type : string
2171- format : binary
2172- required :
2173- - pod
2174- application/octet-stream :
2175- schema :
2176- type : string
2177- format : binary
2178- responses :
2179- ' 201 ' :
2180- description : Pod state loaded successfully.
2181- headers :
2182- Content-Length :
2183- description : Length of the pod in bytes.
2184- schema :
2185- type : integer
2186- ' 400 ' :
2187- description : Bad request.
21882210 /_localstack/pods/state/metamodel :
21892211 get :
21902212 description : Extract a metamodel representing the state of the current LocalStack
@@ -2227,6 +2249,8 @@ paths:
22272249 responses :
22282250 ' 200 ' :
22292251 description : OK
2252+ ' 400 ' :
2253+ description : Invalid request
22302254 ' 500 ' :
22312255 description : Deletion failed
22322256 tags :
@@ -2270,6 +2294,8 @@ paths:
22702294 application/x-ndjson : {}
22712295 description : The response is a sequence of JSON events, according to the
22722296 schema, separated by a newline
2297+ ' 400 ' :
2298+ description : Invalid request
22732299 tags :
22742300 - pro
22752301 - pods
@@ -2391,6 +2417,10 @@ paths:
23912417 type : array
23922418 items :
23932419 $ref : ' #/components/schemas/ReplicationJob'
2420+ ' 400 ' :
2421+ description : Invalid request
2422+ ' 415 ' :
2423+ description : Content-Type was not 'application/json'
23942424 /_localstack/replicator/jobs/{job_id} :
23952425 get :
23962426 tags :
@@ -2430,7 +2460,7 @@ paths:
24302460 ' 200 ' :
24312461 description : List of resources available for replication
24322462 content :
2433- aplication /json :
2463+ application /json :
24342464 schema :
24352465 additionalProperties : false
24362466 type : array
@@ -2550,6 +2580,8 @@ paths:
25502580 application/json :
25512581 schema :
25522582 $ref : ' #/components/schemas/StateResult'
2583+ 404 :
2584+ description : Service not found
25532585 tags :
25542586 - pro
25552587 - state
@@ -2561,6 +2593,8 @@ paths:
25612593 responses :
25622594 ' 200 ' :
25632595 description : Successful
2596+ 404 :
2597+ description : Service not found
25642598 tags :
25652599 - pro
25662600 - state
@@ -2578,6 +2612,8 @@ paths:
25782612 application/json :
25792613 schema :
25802614 $ref : ' #/components/schemas/StateResult'
2615+ 404 :
2616+ description : Service not found
25812617 tags :
25822618 - pro
25832619 - state
0 commit comments