Prepare Zone

POST 
/v1/projects/:projectId/zones/:zoneName/actions/prepare

Prepare the zone for the project resource deployment. This method can be called as often as necessary

Request

Path Parameters

projectId stringrequired

Project Identifier

zoneName stringrequired

Zone name

Header Parameters

Authorization string

Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

X-API-KEY string

Your SIU token if you use this API through Orange Developer.

X-Requester-Id string

Your SIU Id if you use this API through Orange Developer Inside.

Responses

200

Ok

Response Headers

X-Job-Href

Href of the asynchronous job that will process the request, in order to track its status.

X-Retry-After

The number of seconds to wait before checking the status of the job.

application/json

Schema

Schema

iduuidrequired

Resource identifier.

hRefurirequired

Hypertext reference of the resource.

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hRef": "string"
}

OK

{   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",   "hRef": "/projects/{projectId}/zones/{zoneName}" }

400

Bad Request

Request is not valid

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

Not Found

Unknown resource or service

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

405

Method Not Allowed

Operation is not valid according to the state of the resource

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L -X POST '/v1/projects/:projectId/zones/:zoneName/actions/prepare' \
-H 'Accept: application/json'

Request Collapse all

Base URL

/v1

Parameters

projectId — pathrequired

zoneName — pathrequired

Authorization — header

X-API-KEY — header

X-Requester-Id — header