Sources

buildset_status

Introduced in version 43

Summary: GET /v1/craft/buildsets

Return a list of buildsets based on input filters.

URL Parameters

{
    "properties": {
        "buildset-id": {
            "type": [
                "string",
                "null"
            ]
        },
        "channel": {
            "type": [
                "string",
                "null"
            ]
        },
        "package": {
            "description": "A string in 'namespace/name' format.",
            "type": "string"
        },
        "plane": {
            "type": [
                "string",
                "null"
            ]
        },
        "status": {
            "type": [
                "string",
                "null"
            ]
        }
    },
    "required": [
        "package"
    ],
    "type": "object"
}

buildset-id
- Must be ['string', 'null'] type
channel
- Must be ['string', 'null'] type
package
- description: A string in 'namespace/name' format.
- Is required
plane
- Must be ['string', 'null'] type
status
- Must be ['string', 'null'] type

Response JSON Schema

{
    "additionalProperties": false,
    "properties": {
        "buildsets": {
            "items": {
                "additionalProperties": false,
                "properties": {
                    "builds": {
                        "items": {
                            "additionalProperties": false,
                            "properties": {
                                "binary-release": {
                                    "additionalProperties": false,
                                    "properties": {
                                        "channel": {
                                            "additionalProperties": false,
                                            "description": "A list of channels and their metadata for the requested package.",
                                            "properties": {
                                                "branch": {
                                                    "description": "The branch name for this channel, can be null.",
                                                    "type": [
                                                        "string",
                                                        "null"
                                                    ]
                                                },
                                                "name": {
                                                    "description": "The channel name, including \"latest/\" for the latest track.",
                                                    "type": "string"
                                                },
                                                "risk": {
                                                    "description": "The risk name for this channel.",
                                                    "type": "string"
                                                },
                                                "track": {
                                                    "description": "The track name for this channel.",
                                                    "type": "string"
                                                }
                                            },
                                            "required": [
                                                "name",
                                                "track",
                                                "risk",
                                                "branch"
                                            ],
                                            "type": "object"
                                        },
                                        "revision": {
                                            "type": "integer"
                                        }
                                    },
                                    "type": [
                                        "object",
                                        "null"
                                    ]
                                },
                                "completed-at": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                },
                                "created-at": {
                                    "type": "string"
                                },
                                "errors": {
                                    "items": {
                                        "additionalProperties": false,
                                        "properties": {
                                            "code": {
                                                "type": "string"
                                            },
                                            "message": {
                                                "type": "string"
                                            }
                                        },
                                        "required": [
                                            "code",
                                            "message"
                                        ],
                                        "type": "object"
                                    },
                                    "type": "array"
                                },
                                "id": {
                                    "type": "string"
                                },
                                "logs": {
                                    "additionalProperties": false,
                                    "properties": {
                                        "launchpad-build-url": {
                                            "type": [
                                                "string",
                                                "null"
                                            ]
                                        }
                                    },
                                    "type": [
                                        "object",
                                        "null"
                                    ]
                                },
                                "platform": {
                                    "additionalProperties": false,
                                    "properties": {
                                        "architectures": {
                                            "items": {
                                                "type": "string"
                                            },
                                            "minItems": 1,
                                            "type": "array"
                                        },
                                        "channel": {
                                            "type": [
                                                "string",
                                                "null"
                                            ]
                                        },
                                        "name": {
                                            "type": [
                                                "string",
                                                "null"
                                            ]
                                        }
                                    },
                                    "required": [
                                        "name",
                                        "channel",
                                        "architectures"
                                    ],
                                    "type": "object"
                                },
                                "status": {
                                    "enum": [
                                        "failed",
                                        "running",
                                        "succeeded",
                                        "waiting"
                                    ],
                                    "type": "string"
                                }
                            },
                            "required": [
                                "id",
                                "status",
                                "errors",
                                "created-at",
                                "completed-at",
                                "platform",
                                "binary-release",
                                "logs"
                            ],
                            "type": "object"
                        },
                        "type": "array"
                    },
                    "created-at": {
                        "type": "string"
                    },
                    "id": {
                        "type": "string"
                    },
                    "package": {
                        "additionalProperties": false,
                        "properties": {
                            "commit-hash": {
                                "type": "string"
                            },
                            "craft-channel": {
                                "additionalProperties": false,
                                "description": "A list of channels and their metadata for the requested package.",
                                "properties": {
                                    "branch": {
                                        "description": "The branch name for this channel, can be null.",
                                        "type": [
                                            "string",
                                            "null"
                                        ]
                                    },
                                    "name": {
                                        "description": "The channel name, including \"latest/\" for the latest track.",
                                        "type": "string"
                                    },
                                    "risk": {
                                        "description": "The risk name for this channel.",
                                        "type": "string"
                                    },
                                    "track": {
                                        "description": "The track name for this channel.",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "name",
                                    "track",
                                    "risk",
                                    "branch"
                                ],
                                "type": "object"
                            },
                            "craft-revision": {
                                "type": "integer"
                            },
                            "craft-version": {
                                "type": "string"
                            },
                            "id": {
                                "type": "string"
                            },
                            "name": {
                                "type": "string"
                            },
                            "type": {
                                "type": "string"
                            }
                        },
                        "required": [
                            "name",
                            "id",
                            "type",
                            "craft-channel",
                            "commit-hash",
                            "craft-revision",
                            "craft-version"
                        ],
                        "type": "object"
                    },
                    "platforms": {
                        "items": {
                            "additionalProperties": false,
                            "properties": {
                                "architectures": {
                                    "items": {
                                        "type": "string"
                                    },
                                    "minItems": 1,
                                    "type": "array"
                                },
                                "channel": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                },
                                "name": {
                                    "type": [
                                        "string",
                                        "null"
                                    ]
                                }
                            },
                            "required": [
                                "name",
                                "channel",
                                "architectures"
                            ],
                            "type": "object"
                        },
                        "minItems": 1,
                        "type": "array"
                    },
                    "triggers": {
                        "additionalProperties": false,
                        "items": {
                            "properties": {
                                "type": {
                                    "enum": [
                                        "manual",
                                        "commit"
                                    ],
                                    "type": "string"
                                }
                            },
                            "type": "object"
                        },
                        "required": [
                            "type"
                        ],
                        "type": "array"
                    }
                },
                "required": [
                    "id",
                    "package",
                    "platforms",
                    "triggers",
                    "builds",
                    "created-at"
                ],
                "type": "object"
            },
            "type": "array"
        }
    },
    "required": [
        "buildsets"
    ],
    "type": "object"
}

filter_commit_workflows

Introduced in version 44

Summary: GET /v1/craft/commit-workflows

Return a list of commit workflows based on input filters.

URL Parameters

{
    "properties": {
        "channel": {
            "type": [
                "string",
                "null"
            ]
        },
        "commit-hash": {
            "type": [
                "string",
                "null"
            ]
        },
        "commit-workflow-id": {
            "type": [
                "string",
                "null"
            ]
        },
        "domain": {
            "type": [
                "string",
                "null"
            ]
        },
        "package": {
            "description": "A string in 'namespace/name' format.",
            "type": "string"
        },
        "plane": {
            "type": [
                "string",
                "null"
            ]
        }
    },
    "required": [
        "package"
    ],
    "type": "object"
}

channel
- Must be ['string', 'null'] type
commit-hash
- Must be ['string', 'null'] type
commit-workflow-id
- Must be ['string', 'null'] type
domain
- Must be ['string', 'null'] type
package
- description: A string in 'namespace/name' format.
- Is required
plane
- Must be ['string', 'null'] type

Response JSON Schema

{
    "additionalProperties": false,
    "properties": {
        "commit-workflows": {
            "items": {
                "additionalProperties": false,
                "properties": {
                    "buildsets": {
                        "additionalProperties": false,
                        "items": {
                            "properties": {
                                "id": {
                                    "type": "string"
                                }
                            },
                            "type": "object"
                        },
                        "required": [
                            "id"
                        ],
                        "type": "array"
                    },
                    "commit-hash": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "completed-at": {
                        "format": "date-time",
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "craft-channel": {
                        "additionalProperties": false,
                        "description": "A list of channels and their metadata for the requested package.",
                        "properties": {
                            "branch": {
                                "description": "The branch name for this channel, can be null.",
                                "type": [
                                    "string",
                                    "null"
                                ]
                            },
                            "name": {
                                "description": "The channel name, including \"latest/\" for the latest track.",
                                "type": "string"
                            },
                            "risk": {
                                "description": "The risk name for this channel.",
                                "type": "string"
                            },
                            "track": {
                                "description": "The track name for this channel.",
                                "type": "string"
                            }
                        },
                        "required": [
                            "name",
                            "track",
                            "risk",
                            "branch"
                        ],
                        "type": "object"
                    },
                    "craft-revision": {
                        "type": "integer"
                    },
                    "created-at": {
                        "format": "date-time",
                        "type": "string"
                    },
                    "errors": {
                        "items": {
                            "additionalProperties": false,
                            "properties": {
                                "code": {
                                    "type": "string"
                                },
                                "message": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "code",
                                "message"
                            ],
                            "type": "object"
                        },
                        "type": "array"
                    },
                    "id": {
                        "type": "string"
                    },
                    "status": {
                        "type": [
                            "string",
                            "null"
                        ]
                    }
                },
                "required": [
                    "id",
                    "commit-hash",
                    "craft-revision",
                    "craft-channel",
                    "buildsets",
                    "status",
                    "errors",
                    "created-at",
                    "completed-at"
                ],
                "type": "object"
            },
            "type": "array"
        }
    },
    "required": [
        "commit-workflows"
    ],
    "type": "object"
}