CodeLinaro logo
API docs by Redocly

CodeLinaro API (2025-06)

Download OpenAPI specification:Download

E-mail: contact@codelinaro.org License: License Info

CodeLinaro hosts open source projects serving the Arm ecosystem. The projects hosted contain tested open source code needed to provide upstream enablement for innovative, performance optimized support for system on a chip (SoC) products and their related ecosystems. They serve as a staging area for code that is submitted to upstream projects such as the Linux kernel and Android. CodeLinaro also mirrors key upstream projects for use by the community on its git server.

Organization Defined

CodeLinaro services various organizations as well as their customers. Therefore, we use the following to help users keep track of resources within CodeLinaro.

Parameter Definition
parentOrganization The main organization working with CodeLinaro
organization This is the name of either the main organization (same as `parentOrganization`), or a customer of that main organization. This parameter is used to help filter results of various user, project, and metric endpoints.

User & Client Roles

There are currently 4 roles supported in CodeLinaro with only 1 assigned to a user or client application.

Role Description
member Default for all users, primarily for "read-only" purposes
users-admin Allows management of users within the organization; allows resource access for users
projects-admin Allows management of projects within the organization
system-admin Allows management of both users and projects within the organization

Project Roles / Access Levels

There are currently 6 Access Levels supported in CodeLinaro which can be asigned accordingly to users depending on the project needs.

Role / Access Level Description
Admins This role is assigned to users who need the ability to manage a specific project's title, descrption, resources and access controls.
Controller This is just a label calling out specific users who help oversee said project.
Editor This role is assigned to users who need the ability to edit and publish content within the project's wiki so long as the project is public and not inactive.
Reporter This role is assigned to users needing "read-only" access to the project's GitLab and Artifactory repositories so long as the project is not inactive.
Developer This role is given to users who will be contributing to this project's development. They will be able to clone any repository from GitLab and submit pull requests if enabled. They will also have "read-only" access to the project's Artifactory repository as uploads are reserved for Maintainers.
Maintainer This role is given to users who may not only contribute to this project's development, but also approve pull requests and be responsible for releases. They will have full control over this project's GitLab and Artifactory repositories.

Organization Teams

Organization teams supportted by Codelinaro

Get a list of organization Teams

This shall get a list of all the child organization teams created under a given parent org.

Authorizations:
bearerAuthToken
query Parameters
parentOrganization
string
Example: parentOrganization=Linaro

Optional - if you are assigned to only one parent org. | Required - If you belong to more than one parent org

organization
string
Example: organization=Linaro

Optional to filter by the child organization

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/organization/teams?parentOrganization=SOME_STRING_VALUE&organization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Get an organization Team by it's ID

This shall get an organization team by its id .

Authorizations:
bearerAuthToken
path Parameters
teamid
required
integer
Example: 112

The id of the team

query Parameters
parentOrganization
string
Example: parentOrganization=Linaro

Optional - if you are assigned to only one parent org. | Required - If you belong to more than one parent org

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/organization/teams/112?parentOrganization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "id": "string",
  • "org_name": "string",
  • "name": "string",
  • "path": "string",
  • "created_date": "string"
}

Update an organization Team properties by it's ID

This shall update an organization team properties by its id .

Note : For now it can only update the organization team name

Authorizations:
bearerAuthToken
path Parameters
teamid
required
integer
Example: 112

The id of the team

query Parameters
parentOrganization
string
Example: parentOrganization=Linaro

Optional - if you are assigned to only one parent org. | Required - If you belong to more than one parent org

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "new-org-team-01"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Get the staus of the organization teams queue item

This shall get the status of the child organization teams to the project queue item.

Authorizations:
bearerAuthToken
path Parameters
queueid
required
string
Example: 42007afd-2b9c-45d5-a388-985527c185b8

the queue id of the job. (this is a url or path parameter)

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/organization/teams/queue/42007afd-2b9c-45d5-a388-985527c185b8/status \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": "completed | error",
  • "message": "NULL | reason for failure"
}

Users

Handles the overall management of the user accounts in CodeLinaro.

Since Auth0 is the sole identity provider for our users, our API shall be interacting with their Management APIs for all things relating to users. Users are identified uniquely in Auth0 database with set usernames and emails. Once a user is setup in Auth0, their username and email cannot be changed.

NOTE - If a user is supposed to have a @codelinaro account, the account shall need to be created in Auth0 with that email address used as the main email (even though the email account might not be in place immediately).

Get a list of users in CodeLinaro

This shall get a list of all users from the Auth0 database via their Management API. Based on the scope of user making the request, the results shall only show users the requestor is privy to. This endpoint shall also support pagination: ?page=1&limit=100. The API only displays up to 10 users by default.

Authorizations:
bearerAuthToken
query Parameters
organization
string
Example: organization=Linaro

Optional to filter by the users' organization

service
string
Example: service=email

Optional to filter by the users' service

createdAt
string
Example: createdAt=2020-08-01 TO 2020-09-01

Optional to filter by the users' creation date. This value can also be a date range. Format required is 'yyyy-MM-dd'

page
integer
Example: page=1

Optional to retrieve the needed page segment of users

limit
integer
Example: limit=10

Optional to raise or lower the number of users in response

query
string
Example: query=Keyword Search

Optional parameter to search the user list matching given string. The API shall check against username, displayName, and email.

role
string
Example: role=member

Optional parameter to search the user list matching a given role.

status
string
Example: status=active

Optional parameter to search the user list matching a given status.

all
boolean
Example: all=true

Optional parameters are used to return all data.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/users?organization=SOME_STRING_VALUE&service=SOME_STRING_VALUE&createdAt=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&query=SOME_STRING_VALUE&role=SOME_STRING_VALUE&status=SOME_STRING_VALUE&all=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Creates a new user in CodeLinaro

This shall add a user into the Auth0 database via their Management API. Usernames and emails MUST be unique. If a user is supposed to have a @codelinaro email address, the externalEmail field shall not be used for the main identifier in Auth0, but instead shall be added as user metadata.

There are 4 roles available: member,users-admin,projects-admin, and system-admin. Only 1 role shall be assigned to a user. Please see notes above for descriptions about roles.

In order to delete a user, please open a CodeLinaro Support Ticket (servicedesk.codelinaro.org)

NOTE: The parent organization of a user is determined by the token of the application request provided by CodeLinaro Support. The organization defaults to the parent organization recieved by the token. Requestors may send in the same or other organizations (for partners) so long as they already exist in CodeLinaro. If a new organization needs to be added, please open a support ticket with CodeLinaro.

Authorizations:
bearerAuthToken
Request Body schema: application/json
username
string
firstName
required
string
lastName
required
string
displayName
string
externalEmail
required
string
organization
string
role
string
Enum: "member" "projects-admin" "users-admin" "system-admin"

Responses

Request samples

Content type
application/json
{
  • "username": "john.smith",
  • "firstName": "John",
  • "lastName": "Smith",
  • "displayName": "John Smith",
  • "externalEmail": "cool@example.com",
  • "organization": "Linaro",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Get user information in CodeLinaro

This shall return full profile information for said user in CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "username": "john.smith",
  • "firstName": "John",
  • "lastName": "Smith",
  • "displayName": "John Smith",
  • "email": "john.smith@codelinaro.org",
  • "externalEmail": "cool@example.com",
  • "parentOrganization": "Linaro",
  • "organization": "string",
  • "role": "member",
  • "active": "active",
  • "dateCreated": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)",
  • "dateLastAccessed": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)",
  • "picture": "string"
}

Update user information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
firstName
required
string
lastName
required
string
displayName
string
status
string
role
string
Enum: "member" "projects-admin" "users-admin" "system-admin"

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Smith",
  • "displayName": "John Smith",
  • "status": "active",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Update specific user information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
firstName
string
lastName
string
displayName
string
status
string
role
string
Enum: "member" "projects-admin" "users-admin" "system-admin"

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Smith",
  • "displayName": "John Smith",
  • "status": "active",
  • "role": "member"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Sends welcome account setup email to said user

This sends an email which includes a link for users to set a new password on their CodeLinaro account. It also lists the various services availible to said user.

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/send_welcome \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "info": {
    }
}

User - Organization

Handles few management on the user's organization

Updates a user's organization within the user's parent organization

This will help you to transfer a user from one org to another within the same parent organization

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
org_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "org_id": 101
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "description": "Your Request is queued.",
  • "queueid": "62df717a-df43-4da3-a75a-a880f94099b6"
}

Gets the queue status of the user's assignment to the ne org from the above endpoint

Authorizations:
bearerAuthToken
path Parameters
queueid
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/organization/queue/%7Bqueueid%7D/status \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "id": "queue id",
  • "action": "transfer",
  • "username": "username",
  • "org_id": "123",
  • "status": "open",
  • "message": "reason for failure"
}

User Teams

CodeLinaro supports being able to group various users into "teams" for quick and easy project access control management.

Get list of teams

This fetches a list of teams pertaining to an organization within CodeLinaro. This endpoint supports pagination: ?page=1&limit=10.

Authorizations:
bearerAuthToken
query Parameters
serviceType
string
Example: serviceType=wiki
page
integer
Example: page=1

Optional to retrieve the needed page segment of users

limit
integer
Example: limit=10

Optional to raise or lower the number of teams in response

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/teams?serviceType=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a team

This endpoint creates a team of users and allows for admins to specify services applicable.

Authorizations:
bearerAuthToken
Request Body schema: application/json
name
required
string
parentOrganization
string
gitlab
required
boolean
artifactory
required
boolean
wiki
required
boolean
userNames
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "DeveloperServices",
  • "parentOrganization": "Linaro",
  • "gitlab": true,
  • "artifactory": false,
  • "wiki": false,
  • "userNames": [
    ]
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

Get team by team name

This fetches a given team by name pertaining to an organization within CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
teamname
required
string
query Parameters
parentOrganization
required
string
Example: parentOrganization=linaro

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/teams/%7Bteamname%7D?parentOrganization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "services": {
    },
  • "userNames": [
    ],
  • "projects": [
    ]
}

Remove a team from CodeLinaro.

This removes a team, but it does not remove user accounts from CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
teamname
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/teams/%7Bteamname%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Get teams service by team name

This fetches the services of a given team by name pertaining to an organization within CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
teamname
required
string
query Parameters
parentOrganization
required
string
Example: parentOrganization=linaro

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/teams/%7Bteamname%7D/services?parentOrganization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "gitlab": true,
  • "artifactory": true,
  • "wiki": true
}

Enable a team's service categorization

This will NOT enable nor disable a user's service entitlement. This is only a categorization to find and assign teams to projects based on service.

Authorizations:
bearerAuthToken
path Parameters
teamname
required
string
Request Body schema: application/json
parentOrganization
required
string
service
required
string
Enum: "artifactory" "gitlab" "wiki"

Responses

Request samples

Content type
application/json
{
  • "parentOrganization": "Linaro",
  • "service": "wiki"
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

Get teams users list by team name

This fetches the users list of a given team by name pertaining to an organization within CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
teamname
required
string
query Parameters
parentOrganization
required
string
Example: parentOrganization=linaro

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/teams/%7Bteamname%7D/users?parentOrganization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Add a user to teams

This adds a new user to the teams users list

Authorizations:
bearerAuthToken
path Parameters
teamname
required
string
username
required
string
query Parameters
parentOrganization
required
string
Example: parentOrganization=linaro

Responses

Request samples 

curl --request POST \
  --url 'https://api.codelinaro.org/v1/teams/%7Bteamname%7D/users/%7Busername%7D?parentOrganization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Delete a user from teams

This removes a new user from the teams users list

Authorizations:
bearerAuthToken
path Parameters
teamname
required
string
username
required
string
query Parameters
parentOrganization
required
string
Example: parentOrganization=linaro

Responses

Request samples 

curl --request DELETE \
  --url 'https://api.codelinaro.org/v1/teams/%7Bteamname%7D/users/%7Busername%7D?parentOrganization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Get teams projects list by team name

This fetches the projects list of a given team by name pertaining to an organization within CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
teamname
required
string
query Parameters
parentOrganization
required
string
Example: parentOrganization=linaro

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/teams/%7Bteamname%7D/projects?parentOrganization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

User Projects

Retrieve all associated projects for said user

Get all projects belonging to said user in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string
query Parameters
page
integer
Example: page=1

Optional to retrieve the needed page segment of projects

limit
integer
Example: limit=10

Optional to raise or lower the number of projects in response

teamContain
boolean

Optional to contains the project of the team the user belongs to in response

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/users/%7Busername%7D/projects?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&teamContain=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

User Services

Retrieve all associated services for said user

Get all services belonging to said user in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/services \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

User Services Entitlement Queue

Get the status of the user entitlement services queue for (git, artifactory, email, service desk, IRC, wiki)

Get the status of the entitlement queue item

Authorizations:
bearerAuthToken
path Parameters
queueid
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/service/entitlement/queue/%7Bqueueid%7D/status \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": "completed | open | failed",
  • "message": "NULL or reason of failure"
}

User Service - Artifactory

Manages Artifactory (JFrog) service for each user in CodeLinaro

Get user Artifactory information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/artifactory \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Update user Artifactory information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
status
required
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Creates an Artifactory account for said user in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/artifactory \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes user's Artifactory access and account from CodeLinaro.

This shall disable and remove the Artifactory service from said user's CodeLinaro Account.

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/artifactory \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

User Service - Email

Manages Email (Zoho) service for each user in CodeLinaro.

If a user is disabled in CodeLinaro, a PUT request to this endpoint shall be called to block access to the email account in Zoho while keeping the account itself intact.

If a user is removed from CodeLinaro, the email account shall either be archived via PUT request (if marked for retention) or be permanently removed from Zoho via DELETE request.

Get user Email account information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/email \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "username": "john.smith",
  • "link": "mailto:john.smith@codelinaro.org",
  • "mailplan": "non-retention",
  • "status": "active",
  • "displayName": "John Smith"
}

Update user Email account information in CodeLinaro

This shall update the status of a user's access to the email account. If the account mail plan needs to change along with other account settings, please open a ticket.

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
status
required
string

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Creates an Email account for said user in CodeLinaro

Creates a @codelinaro.org email account in Zoho for said user. Based on the information in Auth0, the displayname shall be used on this new email account.

A mailplan needs to be specified if an email account requires retention. The default shall be non-retention if no plan is specified.

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
mailplan
string
Enum: "retention" "non-retention"

Responses

Request samples

Content type
application/json
{
  • "mailplan": "non-retention"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Deletes a non-retention user's Email account in CodeLinaro

This shall permanently remove an email account from Zoho if the account is a non-retention account.

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/email \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

User Service - Service Desk

Manages Service Desk service for each user in CodeLinaro. User shall be able to enter technical support tickets with the CodeLinaro team.

Get user Service Desk account information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/servicedesk \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Update user Service Desk account information in CodeLinaro

This shall update the status of a user's access to the service desk account.

Note: This endpoint has been deprecated and will be removed in future release.

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
status
required
string

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Creates a Service Desk account for said user in CodeLinaro

Creates an account in CodeLinaro Service Desk for said user. Based on the information in Auth0, the displayname, external_email and organization shall be used on this new account.

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/servicedesk \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Deletes a user's account in CodeLinaro Service Desk

This shall permanently remove an account from CodeLinaro Service Desk. Tickets created prior to this operation shall be archived.

Note: This endpoint has been deprecated and will be removed in future release.

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/servicedesk \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

User Service - Git

Manages Git (GitLab) service for each user in CodeLinaro

Get user GitLab information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/git \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Update user GitLab information in CodeLinaro

When automated, this shall update an user's Display Name based on Auth0 profile. A user's status can be changed to active or inactive. When the status is inactive, the account in GitLab shall be deactivated yet preserved. The account can be reactivated when the status is set to active.

See the DELETE operation for terminated accounts.

personalProjectLimit is an optional parameter that will set the number of personal projects that a user can create in CodeLinaro Git. If personal projects are not allowed for an organization a 403(status code) response is expected. Otherwise, if personal projects are allowed for said organization personalProjectLimit can be set up to the max allowed.

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
status
required
string
Enum: "active" "inactive"
personalProjectLimit
integer

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "personalProjectLimit": 1
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Creates a GitLab account for said user in CodeLinaro

personalProjectLimit is an optional parameter that will set the number of personal projects that a user can create in CodeLinaro Git. If personal projects are not allowed for an organization a 403(status code) response is expected. Otherwise, if personal projects are allowed for said organization personalProjectLimit can be set up to the max allowed.

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
name
string
personalProjectLimit
integer

Responses

Request samples

Content type
application/json
{
  • "name": "John Smith",
  • "personalProjectLimit": 1
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes user's GitLab Account from CodeLinaro

This request shall remove the account from GitLab while contributions shall remain under CodeLinaro Admin ownership if necessary.

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/git \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

User Service - IRC

Manages IRC (ZNC) service for each user in CodeLinaro

Get user IRC information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/irc \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Update user IRC information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
status
required
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Creates an IRC (ZNC) account for said user in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
displayName
string

Responses

Request samples

Content type
application/json
{
  • "displayName": "John Smith"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes user's IRC access and account in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/irc \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

User Service - Wiki

Manages Wiki (WikiJS) service for each user in CodeLinaro

Get user Wiki information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/wiki \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Creates a Wiki account for said user in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/wiki \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Update user Wiki information in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string
Request Body schema: application/json
status
required
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes user's Wiki access and account in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/users/%7Busername%7D/wiki \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Projects

Project Management and Operations

Gets a listing of all projects in CodeLinaro

This shall return a slimmed-down list of projects with option to filter by organization, visibility, and status. This endpoint shall also support pagination: ?page=1&limit=100

Authorizations:
bearerAuthToken
query Parameters
page
integer

Optional to retrieve the needed page segment of projects

limit
integer

Optional to raise or lower the number of projects in response

query
string
Example: query=Keyword Search

Optional parameter to search the system for projects matching a given string. The API shall check against project titles and descriptions.

organization
string
Example: organization=Linaro

Optional parameter to search the system for projects from an organization.

status
string
Enum: "active" "inactive" "archived"
Example: status=active

Optional parameter to search the system for projects based on status.

all
boolean
Example: all=true

Optional parameters are used to return all data.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&query=SOME_STRING_VALUE&organization=SOME_STRING_VALUE&status=SOME_STRING_VALUE&all=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Creates a new project in CodeLinaro

This shall create a new project in CodeLinaro. Project information shall be kept in the RDS database. This MUST happen before adding new group to GitLab - see POST /projects/{project-slug}/git

In order to delete a project, please open a CodeLinaro Support Ticket (servicedesk.codelinaro.org)

NOTE:

1). Though optional, eccn is information collected primarily for certain private projects to meet certain international laws.

2).'externalContribution' is an optional property. this is a boolean property with false by default. This is used to mark the project eligible for external users to make their contribution. Setting this property to true or false is only valid if the organization allows this option at the organization level.

Authorizations:
bearerAuthToken
Request Body schema: application/json
name
required
string
description
required
string
projectSlug
string
eccn
string
visibility
string
Enum: "public" "private"
externalContribution
boolean
Enum: false true

Responses

Request samples

Content type
application/json
{
  • "name": "Awesome Project",
  • "description": "This is the description for this awesome project",
  • "projectSlug": "cool-project-name",
  • "eccn": "export-compliance-info-xxxx",
  • "visibility": "private",
  • "externalContribution": false
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Retrieves detailed information for said project in CodeLinaro

All information and relationships concerning this project will be returned - links to GitLab, and all users/roles

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "externalContribution": "true or false",
  • "projectSlug": "cool-project-name",
  • "name": "Cool Project Name",
  • "description": "This would contain a description given for this cool project!",
  • "wikiURL": "https://wiki.codelinaro.org/organization/cool-project-name",
  • "gitlabURL": "https://git.codelinaro.org/organization/cool-project-name",
  • "artifactoryURL": "https://codelinaro.jfrog.io/artifactory/codelinaro-cool-project-name/",
  • "visibility": "public",
  • "status": "active",
  • "restrictionLevel": "read-only",
  • "parentOrganization": "parent org name",
  • "organization": "Child org name",
  • "roles": {
    },
  • "licenses": []
}

Updates an individual project's information in CodeLinaro

This shall allow certain information about a project to be updated in CodeLinaro. It shall NOT allow project-slug nor visibility changes.

In the event of a visibility change, please open a ticket.

NOTE:

1).'externalContribution' is an optional property. this is a boolean property with false by default. This is used to mark the project eligible for external users to make their contribution. Setting this property to true or false is only valid if the organization allows this option at the organization level.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
name
string
description
string
restrictionLevel
string
externalContribution
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Awesome Project",
  • "description": "This is the description for this awesome project",
  • "restrictionLevel": "read-only",
  • "externalContribution": "true or false"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Updates specific project information in CodeLinaro

This shall allow specific information about a project to be updated in CodeLinaro.

In the event of a visibility change, please open a ticket.

NOTE:

1).'externalContribution' is an optional property. this is a boolean property with false by default. This is used to mark the project eligible for external users to make their contribution. Setting this property to true or false is only valid if the organization allows this option at the organization level.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
name
string
description
string
restrictionLevel
string
externalContribution
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Awesome Project",
  • "description": "This is the description for this awesome project",
  • "restrictionLevel": "read-only",
  • "externalContribution": "true or false"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Projects Access Control

Project Management and Operations

Get a list of controllers for said project in CodeLinaro

This shall assign users to the project as controllers in CodeLinaro. These controllers are able to manage this project's information within CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/controllers \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Adds controllers to project in CodeLinaro

This shall assign users to the project as controllers in CodeLinaro. These controllers are able to manage this project's information within CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/controllers/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes controllers from a project in CodeLinaro

This shall remove controllers from this project in CodeLinaro

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/controllers/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Get a list of developers for said project in CodeLinaro

This shall return a list of users on the project as developers in CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
type
string
Example: type=users

Optional to filter by the team

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/developers?type=users' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Adds developers to project in CodeLinaro

This shall schedule a job which will assign users to the project as developers in CodeLinaro. Once the user has been added to RDS database, CodeLinaro shall call GitLab API to add user to the Project Group folder as a 'developer'.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/developers/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes developers from a project in CodeLinaro

This shall remove developers from the project in CodeLinaro as well as GitLab

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/developers/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Get a list of maintainers for said project in CodeLinaro

This shall return a list of users on the project as maintainers in CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
type
string
Example: type=users

Optional to filter by the team

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/maintainers?type=users' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Adds maintainers to project in CodeLinaro

This shall schedule a job which will assign users to the project as maintainers in CodeLinaro. Once the user has been added to RDS database, CodeLinaro shall call GitLab API to add user to the Project Group folder as a 'maintainer'.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/maintainers/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes maintainers from a project in CodeLinaro

This shall remove maintainers from the project in CodeLinaro as well as GitLab

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/maintainers/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Get a list of reporters for said project in CodeLinaro

This shall return a list of users on the project as reporters in CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
type
string
Example: type=users

Optional to filter by the team

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/reporters?type=users' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Adds reporters to project in CodeLinaro

This shall schedule a job which will assign users to the project as reporters in CodeLinaro. Once the user has been added to RDS database, CodeLinaro shall call GitLab API to add user to the Project Group folder as a 'reporter'.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/reporters/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes reporters from a project in CodeLinaro

This shall remove reporters from the project in CodeLinaro as well as GitLab

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/reporters/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Get a list of editors for said project in CodeLinaro

This shall return a list of users on the project as editors in CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
type
string
Example: type=teams

Optional to filter by the team

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/editors?type=teams' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Adds editors to project in CodeLinaro

This shall assign users to the project as editors in CodeLinaro. Once the user has been added to RDS database, CodeLinaro shall ensure user can edit the wiki pages for said project. The user will need to have wiki access in place prior to being assigned this role.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/editors/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes editors from a project in CodeLinaro

This shall remove editors from the project in CodeLinaro as well as the wiki

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/editors/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    }
}

Get a list of administrators for said project

This shall return a list of users on the project as editors in CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
type
string
Example: type=teams

Optional to filter by the team

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/admins?type=teams' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Assigns administrators to a specific project

This assigns a user as an administrator specifically for said project. Once the user has been assigned, said user will be abel to control all access and resource allotments for said project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/admins/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Removes an administrator from a project

This removes an administrator from a single project

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
username
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/admins/users/%7Busername%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    }
}

Projects - Git (Groups & Repositories)

Management of Project's GitLab associations

Retrieves project group information from GitLab

This shall fetch the main group information from GitLab associated to this project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/groups \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Creates a new parent group in GitLab

This shall create a new group under the organization in GitLab. We use 'groups' in GitLab to serve as 'folders' or 'collections' for said CodeLinaro Project. Depending on the visibility of the project, this group shall either be placed under the organization's PRIVATE or PRIVATE namespaces.

Example:

Visibility Path
Default Public /organization/project-slug
Default Private /organization/private/project-slug
*Custom Public /organization/.../custom-public/project-slug
*Custom Public /organization/.../custom-private/project-slug

Git access is controlled at this top 'group' project level. Users must be granted access as a maintainer, developer, or reporter to said project.

*Please open a support ticket to request a custom public/private namespace.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
path
string
request_access_enabled
boolean
enable_ci
boolean

Responses

Request samples

Content type
application/json
{
  • "path": "custom-1/custom-2/custom-3",
  • "request_access_enabled": true,
  • "enable_ci": true
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Updates the parent group in GitLab

This will update the group's properties on gitlab.

The supported properties are below:

Property Type Optional
request_access_enabled Boolean yes
Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
request_access_enabled
boolean
enable_ci
boolean

Responses

Request samples

Content type
application/json
{
  • "request_access_enabled": true,
  • "enable_ci": true
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Deletes a project group from GitLab

This shall permanently delete the project's group, subgroups an repos from GitLab.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/groups \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Retrieves project subgroup information from GitLab

This shall fetch all subgroup information from GitLab associated to this project. This shall support pagination with a default limit of 10 records returned per page.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
path
string
Example: path=platform/external

Optional parameter to search the subgroup list matching a given path. This shall look for paths relative to the project path (based on the path used to initially create the subgroup)

page
integer
Example: page=1

Optional to retrieve the needed page segment of repos

limit
integer
Example: limit=10

Optional to raise or lower the number of repos in response

strict
integer
Example: strict=1

Optional to use a strict filtering. Set strict=1

all
boolean
Example: all=true

Optional parameters are used to return all data.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/subgroups?path=SOME_STRING_VALUE&page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&strict=SOME_INTEGER_VALUE&all=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": []
}

Creates new subgroups in GitLab for this project

This shall create new subgroups under this project's main group in GitLab. CodeLinaro shall parse the subGroups argument and recursively create the sub-groups by calling the GitLab Group API passing a new parent group ID with each iteration. Depending on the visibility of the project, these subgroups shall either be placed under the organization's PRIVATE namespace or it shall be public under the same organization.

"For example: /organization/private/project-slug/sub-group1/sub-group2 vs. /organization/project-slug/sub-group1/sub-group2"

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
subGroups
string

Responses

Request samples

Content type
application/json
{
  • "subGroups": "sub-group-1/sub-group-2/sub-group-3"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Updates the subgroups in GitLab for this project

This will update the subgroup's properties on gitlab.

The supported properties are below:

Property Type Optional
request_access_enabled Boolean yes
Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
groupID
required
string
Request Body schema: application/json
request_access_enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "request_access_enabled": true
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": { }
}

Deletes a project subgroup from GitLab

This shall delete a subgroup along with deeper subgroups and repos from GitLab associated to this project.

  • This shall NOT delete the main project group. See DELETE /project/{project-slug}/git
Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
groupID
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/subgroups/%7BgroupID%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Retrieves a list of respositories in GitLab for this project.

This returns a list of repositories for said project GitLab. Those which return with a gitSourceRepoID not equal to "0" are repos created from a fork. User can then use this paramter to find the source repo used during forking. This shall support pagination with a default limit of 10 records returned per page.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
page
integer
Example: page=1

Optional to retrieve the needed page segment of repos

limit
integer
Example: limit=10

Optional to raise or lower the number of repos in response

status
string
Example: status=deleted

Optional parameter for deleted repo.

all
boolean
Example: all=true

Optional parameters are used to return all data.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/repo?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&all=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": []
}

Creates a new respository in GitLab for this project

Creates a new empty repository (GitLab Project) in the specified project group or subgroup in GitLab service. Added for consistency, the gitSourceRepoID in the response indicates the original repository from which a fork was made. In this case, it returns '0'.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
name
required
string
repoSlug
string
repoPathNew
string
issueTracking
string
Default: "disabled"
Enum: "enabled" "private" "disabled"
mergeRequests
string
Default: "disabled"
Enum: "enabled" "private" "disabled"
requiresDCO
boolean
Default: false
enableLFS
boolean
Default: false
enableForking
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "Name for Repository",
  • "repoSlug": "URL-friendly-name-1.0",
  • "repoPathNew": "sub-group-1/sub-group-2/sub-group-3",
  • "issueTracking": "disabled",
  • "mergeRequests": "disabled",
  • "requiresDCO": false,
  • "enableLFS": false,
  • "enableForking": true
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Retrieves a information of a single respository in GitLab for this project.

This returns information of a single repository for said project GitLab. If the attribute gitSourceRepoID is not equal to "0", this repo was created from a fork. User can then use this paramter to find the source repo used during forking.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/repo/%7BrepoID%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "name": "Cool Repo Name",
  • "gitRepoID": 102019,
  • "status": "archived",
  • "issueTracking": "disabled",
  • "mergeRequests": "disabled",
  • "requiresDCO": false,
  • "enableLFS": false,
  • "webURI": "https://git.codelinaro.org/organization/private/cool-project/cool-repo-name.git",
  • "sshURI": "git@staging-git.codelinaro.org:organization/private/cool-project/cool-repo-name.git",
  • "subgroups": "group-1/group-2",
  • "created": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)",
  • "gitSourceRepoID": 1920,
  • "lastPush": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)",
  • "lastPull": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)",
  • "enableForking": true,
  • "repoSizeBytes": 3256798.56
}

Updates a repository in GitLab for this project

Updates a repository (GitLab Project) for the specified project in GitLab service. The name can be changed and the status of the repo can be switched to active or archived.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string
Request Body schema: application/json
name
string
status
string
Enum: "active" "archived"
issueTracking
string
Default: "disabled"
Enum: "enabled" "private" "disabled"
mergeRequests
string
Default: "disabled"
Enum: "enabled" "private" "disabled"
requiresDCO
boolean
Default: false
enableLFS
boolean
Default: false
enableForking
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "Name for Repository",
  • "status": "active",
  • "issueTracking": "disabled",
  • "mergeRequests": "disabled",
  • "requiresDCO": false,
  • "enableLFS": false,
  • "enableForking": true
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Updates specific repository in GitLab for this project

Updates specific repository (GitLab Project) for said project in GitLab service. The name can be changed and the status of the repo can be switched to active or archived.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string
Request Body schema: application/json
name
string
status
string
Enum: "active" "archived"
issueTracking
string
Default: "disabled"
Enum: "enabled" "private" "disabled"
mergeRequests
string
Default: "disabled"
Enum: "enabled" "private" "disabled"
requiresDCO
boolean
Default: false
enableLFS
boolean
Default: false
enableForking
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "Name for Repository",
  • "status": "active",
  • "issueTracking": "disabled",
  • "mergeRequests": "disabled",
  • "requiresDCO": false,
  • "enableLFS": false,
  • "enableForking": true
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Deletes a repository in GitLab for this project

Deletes a repository (GitLab Project) for the specified project in GitLab service.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/repo/%7BrepoID%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Performs git garbage collection on said repository

This calls the garbage collection operation on the git server directly within the stored repository. This is used in the event git history has been modified or to remove hanging objects no longer referenced.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/repo/%7BrepoID%7D/cleanup \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    }
}

Git commit blocker by email domains

This enables a pre-receive hook on said git respository to inspect all commits included in a single push an reject the push entirely if a committer or author is not authorized based on the email domain. If multiple domains are required, all must be included in the same request. The 2 types that can be applied are author and committer. The startDate need to be specified only if blocking commits after a certain point in time. Otherwise, if it's not specified, it will block for all time.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "emailCheck": [
    ]
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

Remove git commit blocker for email domains

Deletes a pre-receive hook from said git repository which blocked commits from unauthorized email domains.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/repo/%7BrepoID%7D/emailcheck \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Get a specific commit identified by the commit hash or name of a branch or tag.

This returns detailed commit information for said repository from GitLab Commit API (https://docs.gitlab.com/ee/api/commits.html#get-a-single-commit)

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string
sha
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/repo/%7BrepoID%7D/commit/%7Bsha%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Get multiple commits identified by multiple commit hashes or names of branches or tags.

Support searching multiple commits through the get commit (or similar) endpoint: https://docs.codelinaro.org/#tag/Projects-Git-(Groups-and-Repositories)/operation/getProjectGitRepoCommit.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
repoID
required
string
Request Body schema: application/json
shas
required
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "shas": [
    ]
}

Response samples

Content type
application/json
{}

Creates a new fork in GitLab for this project

Creates a new forked repository (GitLab Project) in the specified project group or subgroup in GitLab service. The gitSourceRepoID in the response indicates the original repository from which this fork was made.

Parameter Description
repoPathfrom Must be the full repository clone url (ssh or https)
repoPathNew Optional for specifying the subgroup path if needed (ex. 'sub-group-1/sub-group-2/sub-group-3'). This value can be null or empty (""). The subgroup needs to already exist in Gitlab for this fork.
name The name of the new repository.

Concerning potential STATUS CODE 500: Something went wrong with the fork, please retry later. - If this error message returns, this means a previously attempted fork failed to complete in GitLab. CodeLinaro is cleaning up the failed fork and will not allow a new one to be made until the cleanup has finished.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
repoPathFrom
required
string
repoPathNew
string
name
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Create archive of external git tree

This will create a scheduled task to perform a bare mirror clone of an external git tree, place the contents into a tar.gz file, and publish the compressed file to said project's artifact repository. An email notification will be sent when the file is ready for download. Keep in mind, CodeLinaro only supports this operation for publically accessible git trees. The artifact repository can host several archives.

Note: Currently, tar is the only supported format at this time. Therefore, all archives will be of type .tar.gz. We allow the option to specify the refSpace which could be HEAD (default - latest version), branch name, or a sha commit.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
repoGitURL
required
string
refSpace
required
string
format
required
string
archiveFilename
required
string
prefix
required
string
notification
required
string
object

Responses

Request samples

Content type
application/json
{
  • "repoGitURL": "https://github.com/Requarks/wiki.git",
  • "refSpace": "HEAD",
  • "format": "tar",
  • "archiveFilename": "cool-archive",
  • "prefix": "subdirectory",
  • "notification": "john.smith@codelinaro.org",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Projects - Mirrors

Management of Project's mirror configurations

Gets a list of mirrors for this project

Returns a list of all mirrors regardless of status for the specified project in GitLab service. This shall support pagination with a default limit of 10 records returned per page.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
page
integer
Example: page=1

Optional to retrieve the needed page segment of mirrors

limit
integer
Example: limit=10

Optional to raise or lower the number of mirrors in response

status
string
Example: status=pending,inactive

Optional parameter to search the system for mirrors based on status and multiple statuses are separated by commas.

statusCode
integer
Example: statusCode=404

Optional parameter to retrieve the needed failure code of mirrors.

frequency
string
Example: frequency=once,daily

Optional parameter to search the system for mirrors based on frequency and multiple frequency are separated by commas.

order
string
Example: order=desc

Optional parameter to sort in ascending or descending order according to the date

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/mirrors?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&statusCode=SOME_INTEGER_VALUE&frequency=SOME_STRING_VALUE&order=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": []
}

Creates a new mirror in GitLab for this project

Creates a new mirror for the specified project. A mirrorID shall be created by CodeLinaro based on its place in the RDS database. By default, any submitted mirror shall be considered active. To change this, please see the PUT /projects/{project-slug}/git/mirrors/{mirrorID} method.

This endpoint shall accept source repositories repoURLFrom via HTTP or SSH. However, this requires SSH urls for the destination repository repoURLTo. Please see example.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
repoURLFrom
required
string
repoURLTo
required
string
refSpaceFrom
required
string
refSpaceTo
required
string
frequency
required
string
Enum: "once" "daily" "weekly"
excludeTags
boolean
notificationEmails
Array of strings

Responses

Request samples

Content type
application/json
{
  • "repoURLFrom": "https://cool.git.com/server/example.git",
  • "repoURLTo": "git@git.codelinaro.org:clo/private/prod-project/group-1/prod-repo.git",
  • "refSpaceFrom": "refs/heads/*",
  • "refSpaceTo": "refs/heads/trovalds/*",
  • "frequency": "once",
  • "excludeTags": "false",
  • "notificationEmails": [
    ]
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Gets full information for a specifiic mirror in this project

Retrieves information for a specific mirror for said project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
mirrorID
required
string
query Parameters
status
string
Enum: "pending" "inactive" "mirrored" "in-progress" "failed" "deleted"
Example: status=pending

Optional parameter to search the system for mirrors based on status.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/mirrors/%7BmirrorID%7D?status=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Updates a mirror for this project

Updates a mirror for the specified project in GitLab service. The frequency can be changed and the status of the mirror can be switched to pending or inactive.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
mirrorID
required
string
Request Body schema: application/json
frequency
string
Enum: "once" "daily" "weekly"
status
string
Enum: "pending" "inactive"
excludeTags
boolean

Responses

Request samples

Content type
application/json
{
  • "frequency": "once",
  • "status": "pending",
  • "excludeTags": "true"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Deletes a mirror for this project

Deletes a mirror for the specified project from CodeLinaro's RDS database.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
mirrorID
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/git/mirrors/%7BmirrorID%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Enable a list of selected mirrors for this project

This endpoint takes a list of mirror ID's and enables them.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
mirrorIds
required
Array of integers
notes
required
string

Responses

Request samples

Content type
application/json
{
  • "mirrorIds": [
    ],
  • "notes": "Reason for action"
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

Disable a list of selected mirrors for this project

This endpoint takes a list of mirror ID's and disables them.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
mirrorIds
required
Array of integers
notes
required
string

Responses

Request samples

Content type
application/json
{
  • "mirrorIds": [
    ],
  • "notes": "Reason for action"
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

Enable all mirrors for this project

This endpoint enables all mirrors for a given project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
notes
required
string

Responses

Request samples

Content type
application/json
{
  • "notes": "Reason for action"
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

Disable all mirrors for this project

This endpoint disables all mirrors for a given project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
notes
required
string

Responses

Request samples

Content type
application/json
{
  • "notes": "Reason for action"
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

Projects - Wiki

Management of Project's Wiki content

Retrieves wiki information for said project

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/wiki \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Creates a new wiki space and overview page in the CodeLinaro Wiki for said project

NOTE: If the project is private, only editors have access to the wiki content for said project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/wiki \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Deletes the wiki for said project

This shall the wiki for a public project should that project ever be removed permanantly from CodeLinaro.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/wiki \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    }
}

Generates an API Token to interact with said project's wiki space in CodeLinaro WikiJS

Project Admins and System Admins are able to request a JSON Web Token (JWT). This token shall expire in 12 hours from the time requested.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/wiki/token \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Projects - Artifactory

Handles interaction Artifactory Service

Retrieves the list of artifact repositories for said project

This returns a list of said project's repositories from the Artifactory service. Pagination is also supported, ie. ?page=1&limit=10.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
page
integer
Example: page=1

Optional to retrieve the needed page segment of results

limit
integer
Example: limit=10

Optional to specify the amount of results per page

all
boolean
Example: all=true

Optional parameters are used to return all data.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/artifactory/repos?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&all=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": []
}

Retrieves the information for a single artifact repository

This returns information for a single artifact repository.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
artifactRepoID
required
integer

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/artifactory/repo/%7BartifactRepoID%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{}

Deletes the a project's repository from the Artifactory service

This deletes a single artifact repository for said project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
artifactRepoID
required
integer

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/artifactory/repo/%7BartifactRepoID%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Creates a repository for said project in the Artifactory service

This shall create a repository for this project within the Artifactory service. The project-slug will be used as the repository name within Artifactory by default unless specified. CodeLinaro will append a prefix to this name to coninside with your organization and said project's unique ID, ei. linaro-122-cool-project.

The generic repository type is the default assigned, however, the optional repoType paramters can be specified to be any of the following options:

alpine, bower, cargo, chef, cocoapods, composer, conan, cran, debian, docker, gems, generic, gitlfs, go, gradle, helm, ivy, maven, npm, nuget, opkg, puppet, pypi, rpm, sbt, vagrant, yum

NOTE: If the default name is already in use, you must specify a different name.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
Request Body schema: application/json
name
string
repoType
string

Responses

Request samples

Content type
application/json
{
  • "name": "cool-project",
  • "repoType": "npm"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Retrieves a brief list of all files within an artifactory repository

This shall query the Artifactory Service in JFrog and return a listing of all files within this project's repo. Pagination is supported ie. ?page=1&limit=10.

NOTE: The uri is returned from JFrog and is relative to the repo path.

Authorizations:
bearerAuthToken
path Parameters
artifactRepoID
required
integer
project-slug
required
string
query Parameters
page
integer
Example: page=1

Optional to retrieve the needed page segment of results

limit
integer
Example: limit=10

Optional to specify the amount of results per page (default 10)

all
boolean
Example: all=true

Optional parameters are used to return all data.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/artifactory/%7BartifactRepoID%7D/files?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&all=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Place the artifact in the Artifactory Repository for said project

This shall take a specified file and upload to Artifactory. The folders shall be created to match the specified structure/path in the request. The response includes a status parameter. Status can be pending, active or inactive. If the status is pending, the resource has not yet been uploaded.

The optional metadata legacy parameter (true/false) is used for artifacts that may have been created prior to speocifying other metadata attributes. If the parameter is true, the other metadata parameters are not required.

There is an optional checkSum string parameter that may be sent along with the file upload. Supported formats include MD5, SHA-1, and SHA-256.

There is an optional notification_email string parameter that may be sent along with the file upload. This accepts a valid email or list of emails (seperated by ','). The status of the file upload will be emailed to the given email(s).

Authorizations:
bearerAuthToken
path Parameters
artifactRepoID
required
integer
project-slug
required
string
Request Body schema: application/json
sourceFilePath
required
string
destinationFilePath
required
string
object
checkSum
string
notification_email
string

Responses

Request samples

Content type
application/json
{
  • "sourceFilePath": "https://example.com/server/file.ext",
  • "destinationFilePath": "/path/you/want/for/the/file.ext",
  • "metadata": {
    },
  • "checkSum": "c4f08db2af273a7fe2ab85e5f3496f82",
  • "notification_email": "emailaddress@domain.com"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {}
}

Retrieve the artifact information from the Artifactory Repository for said project

This shall return all information regarding this artifact from the Artifactory Service. For more details, visit (https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API#ArtifactoryRESTAPI-FileInfo)

Authorizations:
bearerAuthToken
path Parameters
artifactRepoID
required
integer
project-slug
required
string
filePath
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/artifactory/%7BartifactRepoID%7D/file/%7BfilePath%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "downloadURL": "https://artifact.codelinaro.org/cool-project/path/to/file.ext",
  • "sourceFilePath": "https://example.com/server/file.ext",
  • "created": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)",
  • "lastModified": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)",
  • "lastUpdated": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)",
  • "size": "1024",
  • "mimeType": "application/pom+xml",
  • "metadata": {
    },
  • "status": "active",
  • "status_note": [
    ],
  • "downloadCount": 2,
  • "lastDownloaded": "ISO8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ)"
}

Update the artifact in the Artifactory Repository for said project

This shall update this artifact's metadata and status in the Artifactory Service.

Authorizations:
bearerAuthToken
path Parameters
artifactRepoID
required
integer
project-slug
required
string
filePath
required
string
Request Body schema: application/json
object
status
required
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Update specific artifact information in the Artifactory Repository for said project

This shall update specific artifact metadata or status in the Artifactory Service.

Authorizations:
bearerAuthToken
path Parameters
artifactRepoID
required
integer
project-slug
required
string
filePath
required
string
Request Body schema: application/json
object
status
required
string
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Deletes the artifact from the Artifactory Repository for said project

This shall delete said artifact from the Artifactory Service.

Authorizations:
bearerAuthToken
path Parameters
artifactRepoID
required
integer
project-slug
required
string
filePath
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/artifactory/%7BartifactRepoID%7D/file/%7BfilePath%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Projects - Licenses

Handles license management for project within CodeLinaro.

Returns Licenses List

This shall return a list of all available licenses within CodeLinaro for project assignment. Please open a support ticket if any licencse needs to be modified or removed. If there's a new license needed, please request with support ticket.

Authorizations:
bearerAuthToken

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/licenses \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[]

Returns a List of Project Licenses

This shall return a list of currently assigned licenses within CodeLinaro for said project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/licenses \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[]

Adds a License to said Project

This shall assign a license to said project. The license MUST exist in CodeLinaro prior to performing this request. See the /licenses endpoint for details. If there's a new license needed, please request with support ticket.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
name
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/licenses/%7Bname%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Deletes a License from said Project

This shall remove a license from said project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
name
required
string

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/licenses/%7Bname%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    }
}

Projects - Pipelines

Handles pipelines for project within CodeLinaro.

Returns a List of Project pipelines.

This shall return a list of pipelines within CodeLinaro for said project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
page
integer
Example: page=1

Optional to retrieve the needed page segment of pipelines

limit
integer
Example: limit=10

Optional to raise or lower the number of pipelines in response

startDate
string
Example: startDate=2022-01-01T00:00:00.000Z

Optional parameter for filtering pipelines start time.

endDate
string
Example: endDate=2022-11-13T00:00:00.000Z

Optional parameter for filtering pipelines end time.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/pipelines?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&startDate=SOME_STRING_VALUE&endDate=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Returns a List of job information of the pipeline.

This shall return a list of job information within CodeLinaro for said pipeline.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
pipelinesid
required
integer
query Parameters
startDate
string
Example: startDate=2022-01-01T00:00:00.000Z

Optional parameter for filtering jobs start time.

endDate
string
Example: endDate=2022-11-13T00:00:00.000Z

Optional parameter for filtering jobs end time.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/pipelines/%7Bpipelinesid%7D?startDate=SOME_STRING_VALUE&endDate=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Projects - Organization Teams

Handles assigning a Organization Team to a project

Queue's the request to assign the given organization team to a project as a maintainer.

Queue's the request to assign the given organization team to a project as a maintainer.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
org-path-id
required
string
Example: org-10-team

Note: 'org-path-id' is the 'path' property from the output of organization teams list endpoint.

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/maintainers/organization/teams/org-10-team \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Queue's the request to remove the given organization team from a project as a maintainer.

Queue's the request to remove the given organization team from a project as a maintainer.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
org-path-id
required
string
Example: org-10-team

Note: 'org-path-id' is the 'path' property from the output of organization teams list endpoint.

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/maintainers/organization/teams/org-10-team \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Queue's the request to assign the given organization team to a project as a developer.

Queue's the request to assign the given organization team to a project as a developer.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
org-path-id
required
string
Example: org-10-team

Note: 'org-path-id' is the 'path' property from the output of organization teams list endpoint.

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/developers/organization/teams/org-10-team \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Queue's the request to remove the given organization team from a project as a developer.

Queue's the request to remove the given organization team from a project as a developer.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
org-path-id
required
string
Example: org-10-team

Note: 'org-path-id' is the 'path' property from the output of organization teams list endpoint.

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/developers/organization/teams/org-10-team \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Queue's the request to assign the given organization team to a project as a reporter.

Queue's the request to assign the given organization team to a project as a reporter.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
org-path-id
required
string
Example: org-10-team

Note: 'org-path-id' is the 'path' property from the output of organization teams list endpoint.

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/reporters/organization/teams/org-10-team \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Queue's the request to remove the given organization team from a project as a reporter.

Queue's the request to remove the given organization team from a project as a reporter.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
org-path-id
required
string
Example: org-10-team

Note: 'org-path-id' is the 'path' property from the output of organization teams list endpoint.

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7Bproject-slug%7D/reporters/organization/teams/org-10-team \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Projects - Persistent Storage

support persistent storage for project(repo) on codeLinaro ci.

support for set up persistent storage for a given project id

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string
repoId
required
integer

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7BprojectSlug%7D/git/repo/%7BrepoId%7D/persistent-storage \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    }
}

support for stop persistent storage for a given project id

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string
repoId
required
integer

Responses

Request samples 

curl --request DELETE \
  --url https://api.codelinaro.org/v1/projects/%7BprojectSlug%7D/git/repo/%7BrepoId%7D/persistent-storage \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    }
}

support for update a project’s persistent storage status (takes parameters of project ID, filing system ID and new status)

Authorizations:
bearerAuthToken
path Parameters
filesystem_id
required
integer
Request Body schema: application/json
status
string
repoID
integer

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "repoID": 54767
}

Response samples

Content type
application/json
{
  • "status": {
    }
}

support for given a parameter of a filing system ID, return the associated project id

Authorizations:
bearerAuthToken
path Parameters
filesystem_id
required
integer

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/systems/persistent-storage/%7Bfilesystem_id%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "repo_id": 54767
}

Projects - CI Bundles

Create Project CI Bundles.

send request to create a bundle for project

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string
Request Body schema: application/json
frequency
string

Responses

Request samples

Content type
application/json
{
  • "frequency": "once"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

get list of bundles for a project

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7BprojectSlug%7D/git/bundles \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": [
    ]
}

send request to create a bundle for project repository

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string
repoId
required
integer
Request Body schema: application/json
frequency
string

Responses

Request samples

Content type
application/json
{
  • "frequency": "once"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Get details of bundle

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string
bundleId
required
integer

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7BprojectSlug%7D/git/bundle/%7BbundleId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Get latest 10 pipelines for provided bundleid

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string
bundleId
required
integer

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7BprojectSlug%7D/git/bundle/%7BbundleId%7D/pipelines \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": [
    ]
}

Get bundle pipeline information

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string
pipelineId
required
integer

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7BprojectSlug%7D/git/bundles/pipelines/%7BpipelineId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

send request to archive project

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/projects/%7BprojectSlug%7D/git/bundles/archive \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Get list of archived projects for your organization

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/projects/%7BprojectSlug%7D/git/bundles/archive \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": [
    ]
}

send request to restore project from archive

Authorizations:
bearerAuthToken
path Parameters
projectSlug
required
string
Request Body schema: application/json
oldproject
string

Responses

Request samples

Content type
application/json
{
  • "oldproject": "old projectSlug Name"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Organizations

Provides the ability to add and view organizations as needed in CodeLinaro.

Returns Organizations List

This shall return a list of all available organizations within CodeLinaro for user alignment. Please open a support ticket if any organization needs to be modified or removed.

Note: temporarily located at /v1/ui/organizations; will be moved to /v1/organizations in a future release

Authorizations:
bearerAuthToken

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/ui/organizations \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "organizations": [
    ]
}

Add New Organization

This creates a new organization within CodeLinaro for future user alignment. Please open a support ticket if any organization needs to be modified or removed.

Authorizations:
bearerAuthToken
Request Body schema: application/json
organization
required
string

Responses

Request samples

Content type
application/json
{
  • "organization": "Acme"
}

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Generates an API Token to interact with all projects' wiki spaces of the parentOrganization in the CodeLinaro WikiJS

System Admins are able to request a JSON Web Token (JWT). This token shall expire in 12 hours from the time requested. The parentOrganization is automatically handled based on the token for said request.

Authorizations:
bearerAuthToken

Responses

Request samples 

curl --request POST \
  --url https://api.codelinaro.org/v1/organizations/wiki \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": {
    },
  • "data": {
    }
}

Returns Organizations List of the users with organization id

This shall return a list of all organization the user belongs to

Authorizations:
bearerAuthToken

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/organization/list \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Helps to rename an organization name

This shall queue the renaming process of an organization and will return the queue id

Authorizations:
bearerAuthToken
path Parameters
orgid
required
integer
Request Body schema: application/json
new_name
string

Responses

Request samples

Content type
application/json
{
  • "new_name": "new name of the org"
}

Response samples

Content type
application/json
{
  • "code": 201,
  • "description": "Your request is queued",
  • "queuid": "900213ea-1302-456d-bd12-8853401282cb"
}

Gives the status of the organization rename job

This shall return the status of the organization rename job

Authorizations:
bearerAuthToken
path Parameters
queueid
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/organization/queue/%7Bqueueid%7D/status \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "id": "900213ea-1302-456d-bd12-8853401282cb",
  • "action": "rename",
  • "old_name": "old-org-name",
  • "new_name": "new-org-name",
  • "status": "open | inprogress | completed",
  • "message": "more-into"
}

Metrics - Reports

Handles system-wide reporting and metrics gathering not bound to a single project.

Returns the total of CodeLinaro users within the organization

Authorizations:
bearerAuthToken
query Parameters
organization
string

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/metrics/users?organization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Returns the total of CodeLinaro users with email enabled within the organization

Authorizations:
bearerAuthToken
query Parameters
organization
string

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/metrics/users/email?organization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Returns the total of CodeLinaro users with gitlab enabled within the organization

Authorizations:
bearerAuthToken
query Parameters
organization
string

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/metrics/users/gitlab?organization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Returns the total of CodeLinaro users with artifactory enabled within the organization

Authorizations:
bearerAuthToken
query Parameters
organization
string

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/metrics/users/artifactory?organization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Returns the total of CodeLinaro users with irc (znc proxy account) enabled within the organization

Authorizations:
bearerAuthToken
query Parameters
organization
string

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/metrics/users/irc?organization=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "data": {
    }
}

This provides a way to query the Auth0 user-database with various filtering options

This shall obtain a list of users (primarily used with the website dashboard pages) from the Auth0 user database. Filters can be applied such as role, and when the user(s) last_login by specific date or range. This has the capability to be expanded in the future.

Authorizations:
bearerAuthToken
path Parameters
organization
required
string
query Parameters
role
string
Example: role=org-users-admin

Filter by the users' system role

last_login
string
Example: last_login=2017-11-01 TO 2017-12-31

Specific date or date range

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/metrics/users/search/%7Borganization%7D?role=SOME_STRING_VALUE&last_login=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Spanning all projects in GitLab, get a list of repos containing a specific commit.

This returns a detailed list of project repos via GitLab's Search API based on a specific commit sha hash key. Visit (https://docs.gitlab.com/ee/api/search.html#scope-commits-starter)

Authorizations:
bearerAuthToken
path Parameters
sha
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.codelinaro.org/v1/metrics/git/search/%7Bsha%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of all pipelines for this project.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
startDate
string
Example: startDate=2022-01-01T00:00:00.000Z

Optional parameter for filtering pipeline start time.

endDate
string
Example: endDate=2022-10-13T00:00:00.000Z

Optional parameter for filtering pipeline end time.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/metrics/projects/%7Bproject-slug%7D/ci/pipelines?startDate=SOME_STRING_VALUE&endDate=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[]

Return total pipelines total duration and total successful or failed pipelines.

Authorizations:
bearerAuthToken
path Parameters
project-slug
required
string
query Parameters
startDate
string
Example: startDate=2022-01-01T00:00:00.000Z

Optional parameter for filtering pipeline start time.

endDate
string
Example: endDate=2022-10-13T00:00:00.000Z

Optional parameter for filtering pipeline end time.

Responses

Request samples 

curl --request GET \
  --url 'https://api.codelinaro.org/v1/metrics/projects/%7Bproject-slug%7D/ci/pipelines/counts?startDate=SOME_STRING_VALUE&endDate=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]