{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Branching Model API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Branching Model",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Get The Branching Model For A Repository",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/branching-model",
"params": [
{
"name": "repo_slug",
"value": "",
"type": "path",
"description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return the branching model as applied to the repository. This view is
read-only. The branching model settings can be changed using the
[settings](#api-repositories-workspace-repo-slug-branching-model-settings-get) API.
The returned object:
1. Always has a `development` property. `development.branch` contains
the actual repository branch object that is considered to be the
`development` branch. `development.branch` will not be present
if it does not exist.
object:
1. Always has a `development` property for the development branch.
2. Always a `production` property for the production branch. The
production branch can be disabled.
3. The `branch_types` contains all the branch types.
This is the raw configuration for the branching model. A client
wishing to see the branching model with its actual current branches may
find the [active model API](/"
},
{
"info": {
"name": "Atlassian Update The Branching Model Config For A Repository",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/branching-model/settings",
"params": [
{
"name": "repo_slug",
"value": "",
"type": "path",
"description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update the branching model configuration for a repository.
The `development` branch can be configured to a specific branch or to
track the main branch. When set to a specific branch it must
currently exist. Only the passed properties will be updated. The
properties not passed will be left unchanged. A request without a
`development` property will leave the development branch unchanged.
It is possible for the `development` branch to be invalid. This
happens when it po"
},
{
"info": {
"name": "Atlassian Get The Effective, Or Currently Applied, Branching Model For A Repository",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/effective-branching-model",
"params": [
{
"name": "repo_slug",
"value": "",
"type": "path",
"description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Atlassian Get The Branching Model For A Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\n"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return the branching model set at the project level. This view is
read-only. The branching model settings can be changed using the
[settings](#api-workspaces-workspace-projects-project-key-branching-model-settings-get)
API.
The returned object:
1. Always has a `development` property. `development.name` is
the user-specified branch that can be inherited by an individual repository's
branching model.
2. Might have a `production` property. `production` will not"
},
{
"info": {
"name": "Atlassian Get The Branching Model Config For A Project",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model/settings",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\n"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Return the branching model configuration for a project. The returned
object:
1. Always has a `development` property for the development branch.
2. Always a `production` property for the production branch. The
production branch can be disabled.
3. The `branch_types` contains all the branch types.
This is the raw configuration for the branching model. A client
wishing to see the branching model with its actual current branches may find the
[active model API]("
},
{
"info": {
"name": "Atlassian Update The Branching Model Config For A Project",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/workspaces/:workspace/projects/:project_key/branching-model/settings",
"params": [
{
"name": "project_key",
"value": "",
"type": "path",
"description": "The project in question. This is the actual `key` assigned\nto the project.\n"
},
{
"name": "workspace",
"value": "",
"type": "path",
"description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update the branching model configuration for a project.
The `development` branch can be configured to a specific branch or to
track the main branch. Any branch name can be supplied, but will only
successfully be applied to a repository via inheritance if that branch
exists for that repository. Only the passed properties will be updated. The
properties not passed will be left unchanged. A request without a
`development` property will leave the development branch unchanged.