Jump to

• Request
• Response

Propose a Deploy Intent

post

/v1/governance/intents/deploy

Proposes a governance intent to deploy the specified components under the policy identified by `uuid`, with a defined deadline and transaction sender in `fromAddress`.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• async: boolean
  Default Value: false
• components(required): array components
  Minimum Number of Items: 1
• deadline(required): integer (int64)
  Future Unix epoch time in seconds.
• fromAddress(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• uuid(required): string

{
    "type":"object",
    "required":[
        "uuid",
        "components",
        "deadline",
        "fromAddress"
    ],
    "properties":{
        "uuid":{
            "type":"string"
        },
        "components":{
            "type":"array",
            "minItems":1,
            "items":{
                "$ref":"#/components/schemas/DeployIntentComponent"
            }
        },
        "deadline":{
            "type":"integer",
            "format":"int64",
            "description":"Future Unix epoch time in seconds."
        },
        "fromAddress":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "async":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : components

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object DeployIntentComponent

{
    "type":"array",
    "minItems":1,
    "items":{
        "$ref":"#/components/schemas/DeployIntentComponent"
    }
}

Nested Schema : DeployIntentComponent

Type: object

Show Source

• implementation(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• implementationCodeHash(required): string
  Pattern: ^0x[a-fA-F0-9]{64}$
• target(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$

{
    "type":"object",
    "required":[
        "target",
        "implementation",
        "implementationCodeHash"
    ],
    "properties":{
        "target":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "implementation":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "implementationCodeHash":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{64}$"
        }
    }
}

Security

• bearerAuth: http
  Type: http

Back to Top

Response

200 Response

Transaction receipt confirmed

202 Response

Transaction submitted or receipt not yet available

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top