Jump to

• Request
• Response

Add or Update Policy

put

/v1/governance/policy

Creates or updates the governance policy identified by `uuid`, configuring its approval threshold and authorized deployer addresses through a transaction submitted by `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
• deployers(required): array deployers
  Minimum Number of Items: 1
• fromAddress(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• threshold(required): integer
  Minimum Value: 0
• uuid(required): string (uuid)

{
    "type":"object",
    "required":[
        "uuid",
        "threshold",
        "deployers",
        "fromAddress"
    ],
    "properties":{
        "uuid":{
            "type":"string",
            "format":"uuid"
        },
        "threshold":{
            "type":"integer",
            "minimum":0
        },
        "deployers":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"string",
                "pattern":"^0x[a-fA-F0-9]{40}$"
            }
        },
        "fromAddress":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "async":{
            "type":"boolean",
            "default":false
        }
    },
    "example":{
        "uuid":"530aea52-fe27-45fa-8785-7da0d34378e3",
        "threshold":3,
        "deployers":[
            "0x34dad2d9a0be504ab4eea2711d8c3da628b82b2c"
        ],
        "fromAddress":"0x34dad2d9a0be504ab4eea2711d8c3da628b82b2c",
        "async":false
    }
}

Example:

{
    "uuid":"530aea52-fe27-45fa-8785-7da0d34378e3",
    "threshold":3,
    "deployers":[
        "0x34dad2d9a0be504ab4eea2711d8c3da628b82b2c"
    ],
    "fromAddress":"0x34dad2d9a0be504ab4eea2711d8c3da628b82b2c",
    "async":false
}

Nested Schema : deployers

Type: array

Minimum Number of Items: 1

Show Source

• Array of: string
  Pattern: ^0x[a-fA-F0-9]{40}$

{
    "type":"array",
    "minItems":1,
    "items":{
        "type":"string",
        "pattern":"^0x[a-fA-F0-9]{40}$"
    }
}

Security

• bearerAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Transaction receipt confirmed

Body ()

Root Schema : SyncGovernanceResponse

Type: object

Show Source

• status(required): string
  Allowed Values: [ "confirmed" ]
• success(required): boolean
• txHash(required): string

{
    "type":"object",
    "required":[
        "status",
        "success",
        "txHash"
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "confirmed"
            ]
        },
        "success":{
            "type":"boolean"
        },
        "txHash":{
            "type":"string"
        }
    }
}

202 Response

Transaction submitted or receipt not yet available

Body ()

Root Schema : AsyncGovernanceResponse

Type: object

Show Source

• status(required): string
  Allowed Values: [ "submitted" ]
• txHash(required): string

{
    "type":"object",
    "required":[
        "status",
        "txHash"
    ],
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "submitted"
            ]
        },
        "txHash":{
            "type":"string"
        }
    }
}

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"
    }
}

401 Response

Unauthorized.

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"
    }
}

403 Response

The authenticated user is not authorized to access the requested wallet or operation.

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